Struct scale_info::TypeDefPhantom

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

A type describing a PhantomData<T> type.

In the context of SCALE encoded types, including PhantomData<T> types in the type info might seem surprising. The reason to include this information is that there could be situations where it's useful and because removing PhantomData items from the derive input quickly becomes a messy syntax-level hack (see PR https://github.com/paritytech/scale-info/pull/31). Instead we take the same approach as parity-scale-codec where users are required to explicitly skip fields that cannot be represented in SCALE encoding, using the #[codec(skip)] attribute.

Implementations

impl TypeDefPhantom

pub fn new(type_param: MetaType) -> Self

Creates a new phantom type definition.

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

pub fn type_param(&self) -> &T::Type

Returns the type parameter type of the phantom type.

Trait Implementations

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

fn clone(&self) -> TypeDefPhantom<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 TypeDefPhantom<T> where
    T::Type: Debug, 

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

Formats the value using the given formatter.

impl<T: Form> Decode for TypeDefPhantom<T> where
    T::Type: Decode,
    T::Type: 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 TypeDefPhantom<T> where
    T::Type: Encode,
    T::Type: 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 encode(&self) -> Vec<u8>

Convert self to an owned vector.

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

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

pub fn size_hint(&self) -> usize

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

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Form> EncodeLike<TypeDefPhantom<T>> for TypeDefPhantom<T> where
    T::Type: Encode,
    T::Type: Encode, 

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

impl From<TypeDefPhantom<MetaForm>> for Type

fn from(phantom: TypeDefPhantom) -> Self

Performs the conversion.

impl<T: Form> From<TypeDefPhantom<T>> for TypeDef<T>

fn from(original: TypeDefPhantom<T>) -> TypeDef<T>

Performs the conversion.

impl IntoPortable for TypeDefPhantom

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

fn cmp(&self, other: &TypeDefPhantom<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<TypeDefPhantom<T>> for TypeDefPhantom<T> where
    T::Type: PartialEq, 

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

fn ge(&self, other: &TypeDefPhantom<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 TypeDefPhantom<T>

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