Struct scale_info::Type

pub struct Type<T: Form = MetaForm> { /* fields omitted */ }

A Type definition with optional metadata.

Implementations

impl Type

pub fn builder() -> TypeBuilder

Create a TypeBuilder the public API for constructing a Type

impl<T> Type<T> where
    T: Form, 

pub fn path(&self) -> &Path<T>

Returns the path of the type

pub fn type_params(&self) -> &[T::Type]

Returns the generic type parameters of the type

pub fn type_def(&self) -> &TypeDef<T>

Returns the definition of the type

Trait Implementations

impl<T: Clone + Form> Clone for Type<T> where
    T::Type: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Form> Debug for Type<T> where
    T::Type: Debug, 

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

Formats the value using the given formatter.

impl<T: Form> Decode for Type<T> where
    Path<T>: Decode,
    Path<T>: Decode,
    Vec<T::Type>: Decode,
    Vec<T::Type>: Decode,
    TypeDef<T>: Decode,
    TypeDef<T>: Decode, 

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

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Form> Encode for Type<T> where
    Path<T>: Encode,
    Path<T>: Encode,
    Vec<T::Type>: Encode,
    Vec<T::Type>: Encode,
    TypeDef<T>: Encode,
    TypeDef<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.

pub fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

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

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

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Form> EncodeLike<Type<T>> for Type<T> where
    Path<T>: Encode,
    Path<T>: Encode,
    Vec<T::Type>: Encode,
    Vec<T::Type>: Encode,
    TypeDef<T>: Encode,
    TypeDef<T>: Encode, 

impl<T: Eq + Form> Eq for Type<T> where
    T::Type: Eq, 

impl<T: Form> From<(Path<T>, Vec<<T as Form>::Type, Global>, TypeDef<T>)> for Type<T>

fn from(original: (Path<T>, Vec<T::Type>, TypeDef<T>)) -> Type<T>

Performs the conversion.

impl From<TypeDefArray<MetaForm>> for Type

fn from(array: TypeDefArray) -> Self

Performs the conversion.

impl From<TypeDefPhantom<MetaForm>> for Type

fn from(phantom: TypeDefPhantom) -> Self

Performs the conversion.

impl From<TypeDefPrimitive> for Type

fn from(primitive: TypeDefPrimitive) -> Self

Performs the conversion.

impl From<TypeDefSequence<MetaForm>> for Type

fn from(sequence: TypeDefSequence) -> Self

Performs the conversion.

impl From<TypeDefTuple<MetaForm>> for Type

fn from(tuple: TypeDefTuple) -> Self

Performs the conversion.

impl IntoPortable for Type

type Output = Type<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 Type<T> where
    T::Type: Ord, 

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq + Form> PartialEq<Type<T>> for Type<T> where
    T::Type: PartialEq, 

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

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

fn ne(&self, other: &Type<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + Form> PartialOrd<Type<T>> for Type<T> where
    T::Type: PartialOrd, 

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

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

fn lt(&self, other: &Type<T>) -> bool

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

fn le(&self, other: &Type<T>) -> bool

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

fn gt(&self, other: &Type<T>) -> bool

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

fn ge(&self, other: &Type<T>) -> bool

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

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

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