Struct SchemaV1 

pub struct SchemaV1<S>
where
    S: CustomSchema,
{
    pub type_kinds: Vec<TypeKind<<S as CustomSchema>::CustomLocalTypeKind, LocalTypeId>>,
    pub type_metadata: Vec<TypeMetadata>,
    pub type_validations: Vec<TypeValidation<<S as CustomSchema>::CustomTypeValidation>>,
}

An array of custom type kinds, and associated extra information which can attach to the type kinds

Fields

type_kinds: Vec<TypeKind<<S as CustomSchema>::CustomLocalTypeKind, LocalTypeId>>

type_metadata: Vec<TypeMetadata>

type_validations: Vec<TypeValidation<<S as CustomSchema>::CustomTypeValidation>>

Implementations

impl<S> SchemaV1<S>

where S: CustomSchema,

pub fn empty() -> SchemaV1<S>

pub fn resolve_type_kind( &self, type_id: LocalTypeId, ) -> Option<&TypeKind<<S as CustomSchema>::CustomLocalTypeKind, LocalTypeId>>

pub fn resolve_type_metadata( &self, type_id: LocalTypeId, ) -> Option<&TypeMetadata>

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

pub fn resolve_matching_enum_metadata<'s>( &self, type_id: LocalTypeId, variant_id: u8, fields_length: usize, ) -> EnumVariantData<'_>

pub fn resolve_matching_array_metadata( &self, type_id: LocalTypeId, ) -> ArrayData<'_>

pub fn resolve_matching_map_metadata(&self, type_id: LocalTypeId) -> MapData<'_>

pub fn resolve_type_name_from_metadata( &self, type_id: LocalTypeId, ) -> Option<&str>

pub fn resolve_type_validation( &self, type_id: LocalTypeId, ) -> Option<&TypeValidation<<S as CustomSchema>::CustomTypeValidation>>

pub fn resolve_type_data( &self, type_id: LocalTypeId, ) -> Option<(&TypeKind<<S as CustomSchema>::CustomLocalTypeKind, LocalTypeId>, &TypeMetadata, &TypeValidation<<S as CustomSchema>::CustomTypeValidation>)>

pub fn validate(&self) -> Result<(), SchemaValidationError>

Trait Implementations

impl<S, X> Categorize<X> for SchemaV1<S>

where S: CustomSchema, X: CustomValueKind,

fn value_kind() -> ValueKind<X>

impl<S> Clone for SchemaV1<S>

where S: Clone + CustomSchema, <S as CustomSchema>::CustomTypeValidation: Clone,

fn clone(&self) -> SchemaV1<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for SchemaV1<S>

where S: Debug + CustomSchema, <S as CustomSchema>::CustomTypeValidation: Debug,

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

Formats the value using the given formatter.

impl<S, D, X> Decode<X, D> for SchemaV1<S>

where S: CustomSchema, D: Decoder<X>, X: CustomValueKind, <S as CustomSchema>::CustomLocalTypeKind: Decode<X, D>, <S as CustomSchema>::CustomTypeValidation: Decode<X, D>,

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

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

impl<S> Default for SchemaV1<S>

where S: CustomSchema,

fn default() -> SchemaV1<S>

Returns the “default value” for a type.

impl<S, C> Describe<C> for SchemaV1<S>

where S: CustomSchema, C: CustomTypeKind<RustTypeId>, <S as CustomSchema>::CustomLocalTypeKind: Describe<C>, <S as CustomSchema>::CustomTypeValidation: Describe<C>,

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<S, E, X> Encode<X, E> for SchemaV1<S>

where S: CustomSchema, E: Encoder<X>, X: CustomValueKind, <S as CustomSchema>::CustomLocalTypeKind: Encode<X, E>, <S as CustomSchema>::CustomTypeValidation: Encode<X, E>,

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<S> From<SchemaV1<S>> for SchemaVersions<S>

where S: CustomSchema,

fn from(value: SchemaV1<S>) -> SchemaVersions<S>

Converts to this type from the input type.

impl<S> From<SchemaV1<S>> for VersionedSchema<S>

where S: CustomSchema,

fn from(value: SchemaV1<S>) -> VersionedSchema<S>

Converts to this type from the input type.

impl<S> PartialEq for SchemaV1<S>

where S: PartialEq + CustomSchema, <S as CustomSchema>::CustomTypeValidation: PartialEq,

fn eq(&self, other: &SchemaV1<S>) -> 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<S, X> SborTuple<X> for SchemaV1<S>

where S: CustomSchema, X: CustomValueKind,

fn get_length(&self) -> usize

impl<S> VersionedSchemaVersion for SchemaV1<S>

where S: CustomSchema,

const DISCRIMINATOR: u8 = 0u8

type Versioned = VersionedSchema<S>

type OwnedSborVariant = SborFixedEnumVariant<sbor::::schema::schema::{impl#16}::OwnedSborVariant::{constant#0}, (SchemaV1<S>,)>

type BorrowedSborVariant<'a> = SborFixedEnumVariant<sbor::::schema::schema::{impl#16}::BorrowedSborVariant::{constant#0}, (&'a SchemaV1<S>,)> where SchemaV1<S>: 'a

fn as_encodable_variant( &self, ) -> <SchemaV1<S> as VersionedSchemaVersion>::BorrowedSborVariant<'_>

Can be used to encode the type as a variant under the Versioned type, without needing to clone, like this: encoder.encode(x.as_encodable_variant()).

fn from_decoded_variant( variant: <SchemaV1<S> as VersionedSchemaVersion>::OwnedSborVariant, ) -> SchemaV1<S>

Can be used to decode the type from an encoded variant, like this: X::from_decoded_variant(decoder.decode()?).

fn into_versioned(self) -> <SchemaV1<S> as VersionedSchemaVersion>::Versioned

impl<S> Eq for SchemaV1<S>

where S: Eq + CustomSchema, <S as CustomSchema>::CustomTypeValidation: Eq,

impl<S> StructuralPartialEq for SchemaV1<S>

where S: CustomSchema,