Struct scale_info::Type

source ·
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>,
}
Expand description

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§

source§

impl Type

source

pub fn builder() -> TypeBuilder

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

source

pub fn builder_portable() -> TypeBuilder<PortableForm>

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

source§

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

source

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.

source§

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

source

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

source

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

source

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

source

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§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Attempt to deserialise the value from input.
source§

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. Read more
source§

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

Attempt to skip the encoded value from input. Read more
source§

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type. Read more
source§

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

source§

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding. Read more
source§

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

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

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

Convert self to an owned vector.
source§

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.
source§

fn encoded_size(&self) -> usize

Calculates the encoded size. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

fn from(item: TypeDefPrimitive) -> Self

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl IntoPortable for Type

§

type Output = Type<PortableForm>

The portable version of Self.
source§

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

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

impl<T: Ord + Form> Ord for Type<T>
where T::String: Ord,

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

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

source§

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

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

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.
source§

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

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

source§

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

source§

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

Auto Trait Implementations§

§

impl<T> Freeze for Type<T>
where <T as Form>::Type: Freeze,

§

impl<T> RefUnwindSafe for Type<T>
where <T as Form>::String: RefUnwindSafe, <T as Form>::Type: RefUnwindSafe,

§

impl<T> Send for Type<T>
where <T as Form>::String: Send, <T as Form>::Type: Send,

§

impl<T> Sync for Type<T>
where <T as Form>::String: Sync, <T as Form>::Type: Sync,

§

impl<T> Unpin for Type<T>
where <T as Form>::String: Unpin, <T as Form>::Type: Unpin,

§

impl<T> UnwindSafe for Type<T>
where <T as Form>::String: UnwindSafe, <T as Form>::Type: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DecodeAll for T
where T: Decode,

source§

fn decode_all(input: &mut &[u8]) -> Result<T, Error>

Decode Self and consume all of the given input data. Read more
source§

impl<T> DecodeLimit for T
where T: Decode,

source§

fn decode_all_with_depth_limit( limit: u32, input: &mut &[u8] ) -> Result<T, Error>

Decode Self and consume all of the given input data. Read more
source§

fn decode_with_depth_limit<I>(limit: u32, input: &mut I) -> Result<T, Error>
where I: Input,

Decode Self with the given maximum recursion depth and advance input by the number of bytes consumed. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> KeyedVec for T
where T: Codec,

source§

fn to_keyed_vec(&self, prepend_key: &[u8]) -> Vec<u8>

Return an encoding of Self prepended by given slice.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<S> Codec for S
where S: Decode + Encode,

source§

impl<T> EncodeLike<&&T> for T
where T: Encode,

source§

impl<T> EncodeLike<&T> for T
where T: Encode,

source§

impl<T> EncodeLike<&mut T> for T
where T: Encode,

source§

impl<T> EncodeLike<Arc<T>> for T
where T: Encode,

source§

impl<T> EncodeLike<Box<T>> for T
where T: Encode,

source§

impl<'a, T> EncodeLike<Cow<'a, T>> for T
where T: ToOwned + Encode,

source§

impl<T> EncodeLike<Rc<T>> for T
where T: Encode,

source§

impl<S> FullCodec for S
where S: Decode + FullEncode,

source§

impl<S> FullEncode for S
where S: Encode + EncodeLike,

source§

impl<T> JsonSchemaMaybe for T