Enum borsh::schema::Fields

pub enum Fields {
    NamedFields(Vec<(FieldName, Declaration)>),
    UnnamedFields(Vec<Declaration>),
    Empty,
}

The collection representing the fields of a struct.

Variants

NamedFields(Vec<(FieldName, Declaration)>)

The struct with named fields.

UnnamedFields(Vec<Declaration>)

The struct with unnamed fields, structurally identical to a tuple.

Empty

The struct with no fields.

Trait Implementations

impl BorshDeserialize for Fields where
    Vec<(FieldName, Declaration)>: BorshDeserialize,
    Vec<Declaration>: BorshDeserialize, 

pub 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.

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

Deserialize this instance from a slice of bytes.

pub fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it's worth handling it as a special case to improve performance. It's a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

impl BorshSchema for Fields

pub fn declaration() -> Declaration

Get the name of the type without brackets.

pub 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.

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

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

pub fn schema_container() -> BorshSchemaContainer

impl BorshSerialize for Fields where
    Vec<(FieldName, Declaration)>: BorshSerialize,
    Vec<Declaration>: BorshSerialize, 

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

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

Serialize this instance into a vector of bytes.

pub fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it's worth handling it as a special case to improve performance. It's a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

impl Debug for Fields

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

Formats the value using the given formatter.

impl PartialEq<Fields> for Fields

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

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

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

This method tests for !=.

impl StructuralPartialEq for Fields