Struct TypeDefPhantom

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

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/tetcoin/tetsy-scale-info/pull/31). Instead we take the same approach as tetsy-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 duplicate of the value.

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,

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

where 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.

fn size_hint(&self) -> usize

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

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

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

Converts to this type from the input type.

impl From<TypeDefPhantom> for Type

fn from(phantom: TypeDefPhantom) -> Self

Converts to this type from the input type.

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.

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

where T::Type: PartialEq,

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

where T::Type: Encode,

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

where T::Type: Eq,

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