Enum scale_info::TypeDef

pub enum TypeDef<T: Form = MetaForm> {
    Composite(TypeDefComposite<T>),
    Variant(TypeDefVariant<T>),
    Sequence(TypeDefSequence<T>),
    Array(TypeDefArray<T>),
    Tuple(TypeDefTuple<T>),
    Primitive(TypeDefPrimitive),
    Compact(TypeDefCompact<T>),
    BitSequence(TypeDefBitSequence<T>),
}

The possible types a SCALE encodable Rust value could have.

Note

In order to preserve backwards compatibility, variant indices are explicitly specified instead of depending on the default implicit ordering.

When adding a new variant, it must be added at the end with an incremented index.

When removing an existing variant, the rest of variant indices remain the same, and the removed index should not be reused.

Variants

Composite(TypeDefComposite<T>)

A composite type (e.g. a struct or a tuple)

Variant(TypeDefVariant<T>)

A variant type (e.g. an enum)

Sequence(TypeDefSequence<T>)

A sequence type with runtime known length.

Array(TypeDefArray<T>)

An array type with compile-time known length.

Tuple(TypeDefTuple<T>)

A tuple type.

Primitive(TypeDefPrimitive)

A Rust primitive type.

Compact(TypeDefCompact<T>)

A type using the [Compact] encoding

BitSequence(TypeDefBitSequence<T>)

A type representing a sequence of bits.

Trait Implementations

impl<T: Clone + Form> Clone for TypeDef<T>

fn clone(&self) -> TypeDef<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Form> Debug for TypeDef<T>

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

Formats the value using the given formatter.

impl<T: Form> Decode for TypeDef<T>where
    TypeDefComposite<T>: Decode,
    TypeDefVariant<T>: Decode,
    TypeDefSequence<T>: Decode,
    TypeDefArray<T>: Decode,
    TypeDefTuple<T>: Decode,
    TypeDefCompact<T>: Decode,
    TypeDefBitSequence<T>: Decode,

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Form> Encode for TypeDef<T>where
    TypeDefComposite<T>: Encode,
    TypeDefVariant<T>: Encode,
    TypeDefSequence<T>: Encode,
    TypeDefArray<T>: Encode,
    TypeDefTuple<T>: Encode,
    TypeDefCompact<T>: Encode,
    TypeDefBitSequence<T>: Encode,

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<F: Form> From<TypeDefArray<F>> for TypeDef<F>

fn from(x: TypeDefArray<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<TypeDefBitSequence<F>> for TypeDef<F>

fn from(x: TypeDefBitSequence<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<TypeDefCompact<F>> for TypeDef<F>

fn from(x: TypeDefCompact<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<TypeDefComposite<F>> for TypeDef<F>

fn from(x: TypeDefComposite<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<TypeDefPrimitive> for TypeDef<F>

fn from(x: TypeDefPrimitive) -> Self

Converts to this type from the input type.

impl<F: Form> From<TypeDefSequence<F>> for TypeDef<F>

fn from(x: TypeDefSequence<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<TypeDefTuple<F>> for TypeDef<F>

fn from(x: TypeDefTuple<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<TypeDefVariant<F>> for TypeDef<F>

fn from(x: TypeDefVariant<F>) -> Self

Converts to this type from the input type.

impl IntoPortable for TypeDef

type Output = TypeDef<PortableForm>

The portable version of Self.

fn into_portable(self, registry: &mut Registry) -> Self::Output

Convert self to the portable form by using the registry for caching.

impl<T: Ord + Form> Ord for TypeDef<T>

fn cmp(&self, other: &TypeDef<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq + Form> PartialEq<TypeDef<T>> for TypeDef<T>

fn eq(&self, other: &TypeDef<T>) -> bool

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

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

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

impl<T: PartialOrd + Form> PartialOrd<TypeDef<T>> for TypeDef<T>

fn partial_cmp(&self, other: &TypeDef<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Form> EncodeLike<TypeDef<T>> for TypeDef<T>where
    TypeDefComposite<T>: Encode,
    TypeDefVariant<T>: Encode,
    TypeDefSequence<T>: Encode,
    TypeDefArray<T>: Encode,
    TypeDefTuple<T>: Encode,
    TypeDefCompact<T>: Encode,
    TypeDefBitSequence<T>: Encode,

impl<T: Eq + Form> Eq for TypeDef<T>

impl<T: Form> StructuralEq for TypeDef<T>

impl<T: Form> StructuralPartialEq for TypeDef<T>