Struct TypeCollectionSchema

pub struct TypeCollectionSchema<S>
where
    S: CustomSchema,
{
    pub schema: VersionedSchema<S>,
    pub type_ids: IndexMap<String, LocalTypeId>,
}

A serializable record of the schema of a set of named types. Intended for historical backwards compatibility of a collection of types in a single schema.

For example, traits, or blueprint interfaces.

Fields

schema: VersionedSchema<S>

type_ids: IndexMap<String, LocalTypeId>

Implementations

impl<S> TypeCollectionSchema<S>

where S: CustomSchema,

pub fn new( schema: VersionedSchema<S>, type_ids: IndexMap<String, LocalTypeId>, ) -> TypeCollectionSchema<S>

pub fn from<T>(from: T) -> TypeCollectionSchema<S>

where T: IntoComparableSchema<TypeCollectionSchema<S>, S>,

pub fn from_aggregator( aggregator: TypeAggregator<<S as CustomSchema>::CustomAggregatorTypeKind>, ) -> TypeCollectionSchema<S>

Trait Implementations

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

where S: CustomSchema, X: CustomValueKind,

fn value_kind() -> ValueKind<X>

impl<S> Clone for TypeCollectionSchema<S>

where S: Clone + CustomSchema,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> ComparableSchema<S> for TypeCollectionSchema<S>

where S: CustomSchema,

fn compare_with<'s>( &'s self, compared: &'s TypeCollectionSchema<S>, settings: &SchemaComparisonSettings, ) -> SchemaComparisonResult<'s, S>

fn encode_to_bytes(&self) -> Vec<u8>

fn encode_to_hex(&self) -> String

fn decode_from_bytes(bytes: &[u8]) -> Self

fn decode_from_hex(hex: &str) -> Self

impl<S> Debug for TypeCollectionSchema<S>

where S: Debug + CustomSchema,

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

Formats the value using the given formatter.

impl<S, D, X> Decode<X, D> for TypeCollectionSchema<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<TypeCollectionSchema<S>, DecodeError>

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

impl<S, C> Describe<C> for TypeCollectionSchema<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 TypeCollectionSchema<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> IntoComparableSchema<TypeCollectionSchema<S>, S> for TypeCollectionSchema<S>

where S: CustomSchema,

fn into_schema(&self) -> TypeCollectionSchema<S>

impl<S, X> SborTuple<X> for TypeCollectionSchema<S>

where S: CustomSchema, X: CustomValueKind,

fn get_length(&self) -> usize