Struct Type

pub struct Type<T: Form = MetaForm> {
    pub path: Path<T>,
    pub type_params: Vec<TypeParameter<T>>,
    pub type_def: TypeDef<T>,
    pub docs: Vec<T::String>,
}

A Type definition with optional metadata.

Fields

path: Path<T>

The unique path to the type. Can be empty for built-in types

type_params: Vec<TypeParameter<T>>

The generic type parameters of the type in use. Empty for non generic types

type_def: TypeDef<T>

The actual type definition

docs: Vec<T::String>

Documentation

Implementations

impl Type

pub fn builder() -> TypeBuilder

Create a TypeBuilder the public API for constructing a Type of MetaForm.

pub fn builder_portable() -> TypeBuilder<PortableForm>

Create a TypeBuilder the public API for constructing a Type of PortableForm for use at runtime.

impl<F> Type<F>

where F: Form,

pub fn new<I, D>( path: Path<F>, type_params: I, type_def: D, docs: Vec<F::String>, ) -> Type<F>

where I: IntoIterator<Item = TypeParameter<F>>, D: Into<TypeDef<F>>,

Create a Type.

impl<T> Type<T>

where T: Form,

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

👎Deprecated since 2.5.0: Prefer to access the fields directly; this getter will be removed in the next major version

Returns the path of the type

pub fn type_params(&self) -> &[TypeParameter<T>]

👎Deprecated since 2.5.0: Prefer to access the fields directly; this getter will be removed in the next major version

Returns the generic type parameters of the type

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

👎Deprecated since 2.5.0: Prefer to access the fields directly; this getter will be removed in the next major version

Returns the definition of the type

pub fn docs(&self) -> &[T::String]

👎Deprecated since 2.5.0: Prefer to access the fields directly; this getter will be removed in the next major version

Returns the documentation of the type

Trait Implementations

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

where T::String: Clone,

fn clone(&self) -> Type<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 Type<T>

where T::String: 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, Vec<TypeParameter<T>>: Decode, TypeDef<T>: Decode, Vec<T::String>: Decode,

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

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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 Type<T>

where Path<T>: Encode, Vec<TypeParameter<T>>: Encode, TypeDef<T>: Encode, Vec<T::String>: Encode,

fn size_hint(&self) -> usize

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

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

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

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

Convert self to an owned vector.

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.

fn encoded_size(&self) -> usize

Calculates the encoded size.

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

fn from( value: (Path<T>, Vec<TypeParameter<T>>, TypeDef<T>, Vec<T::String>), ) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(item: TypeDefPrimitive) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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::String: Ord,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

where T::String: PartialEq,

fn eq(&self, other: &Type<T>) -> 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<T: PartialOrd + Form> PartialOrd for Type<T>

where T::String: 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

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

where Path<T>: Encode, Vec<TypeParameter<T>>: Encode, TypeDef<T>: Encode, Vec<T::String>: Encode,

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

where T::String: Eq,

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