Struct VersionedSchema 

pub struct VersionedSchema<S: CustomSchema> { /* private fields */ }

If you wish to get access to match on the versions, use .as_ref() or .as_mut().

Implementations

impl<S: CustomSchema> VersionedSchema<S>

pub fn new(inner: SchemaVersions<S>) -> Self

impl<S: CustomSchema> VersionedSchema<S>

pub fn v1(&self) -> &SchemaV1<S>

pub fn v1_mut(&mut self) -> &mut SchemaV1<S>

impl<S: CustomSchema> VersionedSchema<S>

pub fn empty() -> Self

Trait Implementations

impl<S: CustomSchema> AsMut<SchemaVersions<S>> for VersionedSchema<S>

fn as_mut(&mut self) -> &mut SchemaVersions<S>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S: CustomSchema> AsRef<SchemaVersions<S>> for VersionedSchema<S>

fn as_ref(&self) -> &SchemaVersions<S>

Converts this type into a shared reference of the (usually inferred) input type.

impl<S: CustomSchema, X: CustomValueKind> Categorize<X> for VersionedSchema<S>

fn value_kind() -> ValueKind<X>

impl<S: Clone + CustomSchema> Clone for VersionedSchema<S>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + CustomSchema> Debug for VersionedSchema<S>

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

Formats the value using the given formatter.

impl<S: CustomSchema, D: Decoder<X>, X: CustomValueKind> Decode<X, D> for VersionedSchema<S>

where S::CustomLocalTypeKind: Decode<X, D>, S::CustomTypeValidation: Decode<X, D>,

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

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

impl<S: CustomSchema> Default for VersionedSchema<S>

fn default() -> Self

Returns the “default value” for a type.

impl<S: CustomSchema, C: CustomTypeKind<RustTypeId>> Describe<C> for VersionedSchema<S>

where S::CustomLocalTypeKind: Describe<C>, S::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: CustomSchema, E: Encoder<X>, X: CustomValueKind> Encode<X, E> for VersionedSchema<S>

where S::CustomLocalTypeKind: Encode<X, E>, S::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: CustomSchema> From<SchemaV1<S>> for VersionedSchema<S>

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

Converts to this type from the input type.

impl<S: CustomSchema> From<SchemaVersions<S>> for VersionedSchema<S>

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

Converts to this type from the input type.

impl<S: CustomSchema> From<VersionedSchema<S>> for SchemaVersions<S>

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

Converts to this type from the input type.

impl<S: PartialEq + CustomSchema> PartialEq for VersionedSchema<S>

fn eq(&self, other: &VersionedSchema<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: CustomSchema, X: CustomValueKind> SborEnum<X> for VersionedSchema<S>

where for<'b_> &'b_ SchemaVersions<S>: SborEnum<X>,

fn get_discriminator(&self) -> u8

fn get_length(&self) -> usize

impl<S: CustomSchema, X: CustomValueKind> SborTuple<X> for VersionedSchema<S>

where for<'b_> &'b_ SchemaVersions<S>: SborTuple<X>,

fn get_length(&self) -> usize

impl<S: CustomSchema> UniqueVersioned for VersionedSchema<S>

fn as_unique_version(&self) -> &Self::LatestVersion

Returns an immutable reference to (currently) the only possible version of the inner content.

fn as_unique_version_mut(&mut self) -> &mut Self::LatestVersion

Returns a mutable reference to (currently) the only possible version of the inner content.

fn into_unique_version(self) -> Self::LatestVersion

Returns the (currently) only possible version of the inner content.

fn from_unique_version(content: Self::LatestVersion) -> Self

Creates the versioned wrapper from the (currently) only possible version.

impl<S: CustomSchema> Versioned for VersionedSchema<S>

fn from_latest_version(latest: Self::LatestVersion) -> Self

Constructs the versioned enum from the latest content

type Versions = SchemaVersions<S>

The type for the enum of versions.

type LatestVersion = SchemaV1<S>

The type for the latest content.

fn is_fully_updated(&self) -> bool

Returns true if at the latest version.

fn in_place_fully_update(&mut self) -> &mut Self

Updates to the latest version in place.

fn fully_update_and_into_latest_version(self) -> Self::LatestVersion

Updates itself to the latest version, then returns the latest content

fn as_latest_version(&self) -> Option<&Self::LatestVersion>

If the versioned wrapper is at the latest version, it returns an immutable reference to the latest content, otherwise it returns None.

fn as_latest_version_mut(&mut self) -> Option<&mut Self::LatestVersion>

If the versioned wrapper is at the latest version, it returns a mutable reference to the latest content, otherwise it returns None.

fn as_versions(&self) -> &Self::Versions

Gets a reference the inner versions enum, for e.g. matching on the enum.

fn as_versions_mut(&mut self) -> &mut Self::Versions

Gets a mutable reference the inner versions enum, for e.g. matching on the enum.

fn into_versions(self) -> Self::Versions

Removes the upgradable wrapper to get at the inner versions enum, for e.g. matching on the enum.

fn from_versions(version: Self::Versions) -> Self

Creates a new Versioned wrapper from a given specific version.

fn in_place_fully_update_and_as_latest_version_mut( &mut self, ) -> &mut Self::LatestVersion

Updates the latest version in place, and returns a &mut to the latest content

fn fully_update(self) -> Self

Consumes self, updates to the latest version and returns itself.

impl<S: Eq + CustomSchema> Eq for VersionedSchema<S>

impl<S: CustomSchema> StructuralPartialEq for VersionedSchema<S>