Struct TypeMetadata

pub struct TypeMetadata {
    pub type_name: Option<Cow<'static, str>>,
    pub child_names: Option<ChildNames>,
}

This enables the type to be represented as eg JSON Also used to facilitate type reconstruction

Fields

type_name: Option<Cow<'static, str>>

child_names: Option<ChildNames>

Implementations

impl TypeMetadata

pub fn unnamed() -> TypeMetadata

pub fn no_child_names(name: &'static str) -> TypeMetadata

pub fn struct_fields( name: &'static str, field_names: &[&'static str], ) -> TypeMetadata

pub fn enum_variants( name: &'static str, variant_naming: IndexMap<u8, TypeMetadata>, ) -> TypeMetadata

pub fn with_name(self, name: Option<Cow<'static, str>>) -> TypeMetadata

pub fn with_type_hash(self, type_hash: [u8; 20]) -> NovelTypeMetadata

pub fn get_name(&self) -> Option<&str>

pub fn get_name_string(&self) -> Option<String>

pub fn get_field_names<'a>(&'a self) -> Option<&'a [Cow<'static, str>]>

pub fn get_field_name<'a>(&'a self, field_index: usize) -> Option<&'a str>

pub fn get_enum_variant_data<'a>( &'a self, discriminator: u8, ) -> Option<&'a TypeMetadata>

pub fn get_matching_tuple_data(&self, fields_length: usize) -> TupleData<'_>

pub fn get_matching_enum_variant_data( &self, variant_id: u8, fields_length: usize, ) -> EnumVariantData<'_>

Trait Implementations

impl<X> Categorize<X> for TypeMetadata

where X: CustomValueKind,

fn value_kind() -> ValueKind<X>

impl Clone for TypeMetadata

fn clone(&self) -> TypeMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeMetadata

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

Formats the value using the given formatter.

impl<D, X> Decode<X, D> for TypeMetadata

where D: Decoder<X>, X: CustomValueKind,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<X>, ) -> Result<TypeMetadata, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl<C> Describe<C> for TypeMetadata

where C: CustomTypeKind<RustTypeId>,

const TYPE_ID: RustTypeId

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<C, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<E, X> Encode<X, E> for TypeMetadata

where E: Encoder<X>, X: CustomValueKind,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl PartialEq for TypeMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<X> SborTuple<X> for TypeMetadata

where X: CustomValueKind,

fn get_length(&self) -> usize

impl Eq for TypeMetadata

impl StructuralPartialEq for TypeMetadata