Struct borsh::schema::BorshSchemaContainer

[+] Show declaration

pub struct BorshSchemaContainer {
    pub declaration: Declaration,
    pub definitions: HashMap<Declaration, Definition>,
}

[−] Expand description

All schema information needed to deserialize a single type.

Fields

declaration: Declaration

[−] Expand description

Declaration of the type.

definitions: HashMap<Declaration, Definition>

[−] Expand description

All definitions needed to deserialize the given type.

Trait Implementations

impl BorshDeserialize for BorshSchemaContainer where
    Declaration: BorshDeserialize,
    HashMap<Declaration, Definition>: BorshDeserialize, [+]

[+] Show hidden undocumented items

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>[−]

Deserialize this instance from a slice of bytes.

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 BorshSchemaContainer where
    Declaration: BorshSchema,
    HashMap<Declaration, Definition>: BorshSchema, [+]

[+] Show hidden undocumented items

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 BorshSchemaContainer where
    Declaration: BorshSerialize,
    HashMap<Declaration, Definition>: BorshSerialize, [+]

[+] Show hidden undocumented items

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.

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 BorshSchemaContainer[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl PartialEq<BorshSchemaContainer> for BorshSchemaContainer[+]

[+] Show hidden undocumented items

fn eq(&self, other: &BorshSchemaContainer) -> bool[−]

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

fn ne(&self, other: &BorshSchemaContainer) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for BorshSchemaContainer