Struct near_sdk::MethodMetadata

pub struct MethodMetadata {
    pub name: String,
    pub is_view: bool,
    pub is_init: bool,
    pub args: Option<BorshSchemaContainer>,
    pub callbacks: Vec<BorshSchemaContainer>,
    pub callbacks_vec: Option<BorshSchemaContainer>,
    pub result: Option<BorshSchemaContainer>,
}

Metadata of a single method.

Fields

name: String

is_view: bool

Whether method does not modify the state.

is_init: bool

Whether method can be used to initialize the state.

args: Option<BorshSchemaContainer>

Schema of the arguments of the method.

callbacks: Vec<BorshSchemaContainer>

Schemas for each callback of the method.

callbacks_vec: Option<BorshSchemaContainer>

If all callbacks have the same type then this field can be used instead.

result: Option<BorshSchemaContainer>

Schema of the return type.

Trait Implementations

impl BorshDeserialize for MethodMetadata where
    String: BorshDeserialize,
    bool: BorshDeserialize,
    bool: BorshDeserialize,
    Option<BorshSchemaContainer>: BorshDeserialize,
    Vec<BorshSchemaContainer>: BorshDeserialize,
    Option<BorshSchemaContainer>: BorshDeserialize,
    Option<BorshSchemaContainer>: BorshDeserialize, 

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 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 MethodMetadata where
    String: BorshSchema,
    bool: BorshSchema,
    bool: BorshSchema,
    Option<BorshSchemaContainer>: BorshSchema,
    Vec<BorshSchemaContainer>: BorshSchema,
    Option<BorshSchemaContainer>: BorshSchema,
    Option<BorshSchemaContainer>: BorshSchema, 

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: String,
    definition: Definition,
    definitions: &mut HashMap<String, Definition, RandomState>
)

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

fn schema_container() -> BorshSchemaContainer

impl BorshSerialize for MethodMetadata where
    String: BorshSerialize,
    bool: BorshSerialize,
    bool: BorshSerialize,
    Option<BorshSchemaContainer>: BorshSerialize,
    Vec<BorshSchemaContainer>: BorshSerialize,
    Option<BorshSchemaContainer>: BorshSerialize,
    Option<BorshSchemaContainer>: BorshSerialize, 

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

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

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 MethodMetadata

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq<MethodMetadata> for MethodMetadata

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

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

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

This method tests for !=.

impl StructuralPartialEq for MethodMetadata