Enum frame_support::traits::Bounded

pub enum Bounded<T, H: Hash> {
    Legacy {
        hash: H::Output,
        dummy: PhantomData<T>,
    },
    Inline(BoundedInline),
    Lookup {
        hash: H::Output,
        len: u32,
    },
}

Variants

Legacy

A hash with no preimage length. We do not support creation of this except for transitioning from legacy state. In the future we will make this a pure Dummy item storing only the final dummy field.

Fields

hash: H::Output

dummy: PhantomData<T>

Inline(BoundedInline)

A an bounded Call. Its encoding must be at most 128 bytes.

Lookup

A hash of the call together with an upper limit for its size.`

Fields

hash: H::Output

len: u32

Implementations

impl<T, H: Hash> Bounded<T, H>

pub fn transmute<S: Encode>(self) -> Bounded<S, H>

where T: Encode + EncodeLike<S>,

Casts the wrapped type into something that encodes alike.

Examples

use frame_support::{traits::Bounded, sp_runtime::traits::BlakeTwo256};

// Transmute from `String` to `&str`.
let x: Bounded<String, BlakeTwo256> = Bounded::Inline(Default::default());
let _: Bounded<&str, BlakeTwo256> = x.transmute();

pub fn hash(&self) -> H::Output

Returns the hash of the preimage.

The hash is re-calculated every time if the preimage is inlined.

pub fn lookup_hash(&self) -> Option<H::Output>

Returns the hash to lookup the preimage.

If this is a Bounded::Inline, None is returned as no lookup is required.

pub fn len(&self) -> Option<u32>

Returns the length of the preimage or None if the length is unknown.

pub fn lookup_needed(&self) -> bool

Returns whether the image will require a lookup to be peeked.

pub fn lookup_len(&self) -> Option<u32>

The maximum length of the lookup that is needed to peek Self.

pub fn unrequested(hash: H::Output, len: u32) -> Self

Constructs a Lookup bounded item.

pub fn from_legacy_hash(hash: impl Into<H::Output>) -> Self

👎Deprecated: This API is only for transitioning to Scheduler v3 API

Constructs a Legacy bounded item.

Trait Implementations

impl<T: Clone, H: Clone + Hash> Clone for Bounded<T, H>

where H::Output: Clone,

fn clone(&self) -> Bounded<T, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, H> Debug for Bounded<T, H>

where T: Debug, H: Debug + Hash,

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

Formats the value using the given formatter.

impl<T, H: Hash> Decode for Bounded<T, H>

where H::Output: Decode, PhantomData<T>: 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, H: Hash> Encode for Bounded<T, H>

where H::Output: Encode, PhantomData<T>: 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, H: Hash> MaxEncodedLen for Bounded<T, H>

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T: PartialEq, H: PartialEq + Hash> PartialEq for Bounded<T, H>

where H::Output: PartialEq,

fn eq(&self, other: &Bounded<T, H>) -> 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, H> TypeInfo for Bounded<T, H>

where H::Output: TypeInfo + 'static, PhantomData<T>: TypeInfo + 'static, T: TypeInfo + 'static, H: Hash + TypeInfo + 'static,

type Identity = Bounded<T, H>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T, H: Hash> EncodeLike for Bounded<T, H>

where H::Output: Encode, PhantomData<T>: Encode,

impl<T: Eq, H: Eq + Hash> Eq for Bounded<T, H>

where H::Output: Eq,

impl<T, H: Hash> StructuralPartialEq for Bounded<T, H>