Struct scale_info::TypeDefBitSequence

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

Type describing a [bitvec::vec::BitVec].

Note

This can only be constructed for TypeInfo in the MetaForm with the bit-vec feature enabled, but can be decoded or deserialized into the PortableForm without this feature.

Implementations

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

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

Returns the type of the bit ordering of the [::bitvec::vec::BitVec].

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

Returns underlying type used to store the [::bitvec::vec::BitVec].

impl TypeDefBitSequence

pub fn new<Store, Order>() -> Selfwhere
    Store: TypeInfo + 'static,
    Order: TypeInfo + 'static,

Creates a new TypeDefBitSequence for the supplied bit order and bit store types.

With the bit-vec feature enabled, the expected usage is to provide either bitvec::order::Lsb0 or bitvec::order::Msb0 as the order type, and then something like u8, u8, or u32 as the store type. Without the bit-vec feature enabled, it’s recommended that your types have identical TypeInfo to those.

impl TypeDefBitSequence<PortableForm>

pub fn new_portable(
    bit_store_type: <PortableForm as Form>::Type,
    bit_order_type: <PortableForm as Form>::Type
) -> Self

Creates a new TypeDefBitSequence for the supplied bit order and bit store types.

Trait Implementations

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

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

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

Formats the value using the given formatter.

impl<T: Form> Decode for TypeDefBitSequence<T>where
    T::Type: Decode,
    T::Type: Decode,
    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.

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 TypeDefBitSequence<T>where
    T::Type: Encode,
    T::Type: Encode,
    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 size_hint(&self) -> usize

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    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<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<TypeDefBitSequence<F>> for TypeDef<F>

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

Converts to this type from the input type.

impl IntoPortable for TypeDefBitSequence

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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