Enum switchboard_solana::prelude::borsh::schema::Definition

pub enum Definition {
    Array {
        length: u32,
        elements: String,
    },
    Sequence {
        elements: String,
    },
    Tuple {
        elements: Vec<String>,
    },
    Enum {
        variants: Vec<(String, String)>,
    },
    Struct {
        fields: Fields,
    },
}

The type that we use to represent the definition of the Borsh type.

Variants

Array

Fields

length: u32

elements: String

A fixed-size array with the length known at the compile time and the same-type elements.

Sequence

Fields

elements: String

A sequence of elements of length known at the run time and the same-type elements.

Tuple

Fields

elements: Vec<String>

A fixed-size tuple with the length known at the compile time and the elements of different types.

Enum

Fields

variants: Vec<(String, String)>

A tagged union, a.k.a enum. Tagged-unions have variants with associated structures.

Struct

Fields

fields: Fields

A structure, structurally similar to a tuple.

Trait Implementations

impl BorshDeserialize for Definition

where u32: BorshDeserialize, String: BorshDeserialize, Vec<String>: BorshDeserialize, Vec<(String, String)>: BorshDeserialize, Fields: BorshDeserialize,

fn deserialize_reader<R>(reader: &mut R) -> Result<Definition, Error>

where R: Read,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for Definition

where u32: BorshSerialize, String: BorshSerialize, Vec<String>: BorshSerialize, Vec<(String, String)>: BorshSerialize, Fields: BorshSerialize,

fn serialize<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

impl BorshSchema for Definition

fn declaration() -> String

Get the name of the type without brackets.

fn add_definitions_recursively(definitions: &mut HashMap<String, Definition>)

Recursively, using DFS, add type definitions required for this type. For primitive types this is an empty map. Type definition explains how to serialize/deserialize a type.

fn add_definition( declaration: String, definition: Definition, definitions: &mut HashMap<String, Definition> )

Helper method to add a single type definition to the map.

fn schema_container() -> BorshSchemaContainer

impl Clone for Definition

fn clone(&self) -> Definition

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Definition

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl EnumExt for Definition

where u32: BorshDeserialize, String: BorshDeserialize, Vec<String>: BorshDeserialize, Vec<(String, String)>: BorshDeserialize, Fields: BorshDeserialize,

fn deserialize_variant<R>( reader: &mut R, variant_idx: u8 ) -> Result<Definition, Error>

where R: Read,

Deserialises given variant of an enum from the reader.

impl PartialEq for Definition

fn eq(&self, other: &Definition) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Definition

impl StructuralPartialEq for Definition