Enum borsh::schema::Definition

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

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

Variants

Array

Fields

length: u32

elements: Declaration

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

Sequence

Fields

elements: Declaration

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

Tuple

Fields

elements: Vec<Declaration>

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

Enum

Fields

variants: Vec<(VariantName, Declaration)>

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 Definitionwhere u32: BorshDeserialize, Declaration: BorshDeserialize, Vec<Declaration>: BorshDeserialize, Vec<(VariantName, Declaration)>: BorshDeserialize, Fields: BorshDeserialize,

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

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

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>

Deserialize this instance from a slice of bytes.

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

impl BorshSchema for Definition

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut HashMap<Declaration, 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: Declaration, definition: Definition, definitions: &mut HashMap<Declaration, Definition> )

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

fn schema_container() -> BorshSchemaContainer

impl BorshSerialize for Definitionwhere u32: BorshSerialize, Declaration: BorshSerialize, Vec<Declaration>: BorshSerialize, Vec<(VariantName, Declaration)>: BorshSerialize, Fields: BorshSerialize,

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

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

Serialize this instance into a vector of bytes.

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

Formats the value using the given formatter.

impl EnumExt for Definitionwhere u32: BorshDeserialize, Declaration: BorshDeserialize, Vec<Declaration>: BorshDeserialize, Vec<(VariantName, Declaration)>: BorshDeserialize, Fields: BorshDeserialize,

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

Deserialises given variant of an enum from the reader.

impl PartialEq<Definition> 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 StructuralEq for Definition

impl StructuralPartialEq for Definition