Struct frame_support::storage::types::Key

source · [−]

pub struct Key<Hasher, KeyType>(_);

Expand description

A type used exclusively by storage maps as their key type.

The final key generated has the following form:

Hasher1(encode(key1))
    ++ Hasher2(encode(key2))
    ++ ...
    ++ HasherN(encode(keyN))

Trait Implementations

source

impl<H: StorageHasher, K: FullCodec + StaticTypeInfo> KeyGenerator for Key<H, K>

type Key = K

type KArg = (K,)

type HashFn = Box<dyn FnOnce(&[u8 ]) -> Vec<u8>>

type HArg = (Self::HashFn ,)

source

const HASHER_METADATA: &'static [StorageHasher ]

source

fn final_key<KArg: EncodeLikeTuple<Self::KArg> + TupleToEncodedIter>(
key: KArg
) -> Vec<u8>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

Given a key tuple, calculate the final key by encoding each element individually and hashing them using the corresponding hasher in the KeyGenerator. Read more

source

fn migrate_key<KArg: EncodeLikeTuple<Self::KArg> + TupleToEncodedIter>(
 key: &KArg,
 hash_fns: Self::HArg
) -> Vec<u8>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

Given a key tuple, migrate the keys from using the old hashers as given by hash_fns to using the newer hashers as specified by this KeyGenerator. Read more

source

impl<H: StorageHasher, K: FullCodec + MaxEncodedLen + StaticTypeInfo> KeyGeneratorMaxEncodedLen for Key<H, K>

source

fn key_max_encoded_len() -> usize

source

impl<H: ReversibleStorageHasher, K: FullCodec + StaticTypeInfo> ReversibleKeyGenerator for Key<H, K>

type ReversibleHasher = H

source

fn decode_final_key(key_material: &[u8 ]) -> Result<(Self::Key, &[u8 ]), Error>

Auto Trait Implementations

impl<Hasher, KeyType> RefUnwindSafe for Key<Hasher, KeyType> where
Hasher: RefUnwindSafe,
KeyType: RefUnwindSafe,

impl<Hasher, KeyType> Send for Key<Hasher, KeyType> where
Hasher: Send,
KeyType: Send,

impl<Hasher, KeyType> Sync for Key<Hasher, KeyType> where
Hasher: Sync,
KeyType: Sync,

impl<Hasher, KeyType> Unpin for Key<Hasher, KeyType> where
Hasher: Unpin,
KeyType: Unpin,

impl<Hasher, KeyType> UnwindSafe for Key<Hasher, KeyType> where
Hasher: UnwindSafe,
KeyType: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> CheckedConversion for T

source

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

source

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

source

impl<T> Downcast for T where
T: Any,

source

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘ
Notable traits for Box<W, Global>
`impl<W> Write for Box<W, Global> where W: Write + ?Sized, impl<R> Read for Box<R, Global> where R: Read + ?Sized, impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;`

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> DowncastSync for T where
T: Any + Send + Sync,

source

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

source

pub fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

source

pub fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> SaturatedConversion for T

source

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

source

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

source

pub fn unchecked_into(self) -> T

The counterpart to unchecked_from.

source

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

source

pub fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct frame_support::storage::types::Key

Trait Implementations

impl<H: StorageHasher, K: FullCodec + StaticTypeInfo> KeyGenerator for Key<H, K>

type Key = K

type KArg = (K,)

type HashFn = Box<dyn FnOnce(&[u8]) -> Vec<u8>>

type HArg = (Self::HashFn,)

const HASHER_METADATA: &'static [StorageHasher]

fn final_key<KArg: EncodeLikeTuple<Self::KArg> + TupleToEncodedIter>( key: KArg) -> Vec<u8>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

fn migrate_key<KArg: EncodeLikeTuple<Self::KArg> + TupleToEncodedIter>( key: &KArg, hash_fns: Self::HArg) -> Vec<u8>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

impl<H: StorageHasher, K: FullCodec + MaxEncodedLen + StaticTypeInfo> KeyGeneratorMaxEncodedLen for Key<H, K>

fn key_max_encoded_len() -> usize

impl<H: ReversibleStorageHasher, K: FullCodec + StaticTypeInfo> ReversibleKeyGenerator for Key<H, K>

type ReversibleHasher = H

fn decode_final_key(key_material: &[u8]) -> Result<(Self::Key, &[u8]), Error>

Auto Trait Implementations

impl<Hasher, KeyType> RefUnwindSafe for Key<Hasher, KeyType> where Hasher: RefUnwindSafe, KeyType: RefUnwindSafe,

impl<Hasher, KeyType> Send for Key<Hasher, KeyType> where Hasher: Send, KeyType: Send,

impl<Hasher, KeyType> Sync for Key<Hasher, KeyType> where Hasher: Sync, KeyType: Sync,

impl<Hasher, KeyType> Unpin for Key<Hasher, KeyType> where Hasher: Unpin, KeyType: Unpin,

impl<Hasher, KeyType> UnwindSafe for Key<Hasher, KeyType> where Hasher: UnwindSafe, KeyType: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self> where Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where Self: TryInto<T>,

impl<T> Downcast for T where T: Any,

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T, Outer> IsWrappedBy<Outer> for T where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

pub fn from_ref(outer: &Outer) -> &T

pub fn from_mut(outer: &mut Outer) -> &mut T

impl<T> Same<T> for T

type Output = T

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Self where Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where Self: UniqueSaturatedInto<T>,

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

type Error = Infallible

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

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

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

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

impl<S, T> UncheckedInto<T> for S where T: UncheckedFrom<S>,

pub fn unchecked_into(self) -> T

impl<T, S> UniqueSaturatedInto<T> for S where T: Bounded, S: TryInto<T>,

pub fn unique_saturated_into(self) -> T

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> MaybeRefUnwindSafe for T where T: RefUnwindSafe,

type HashFn = Box<dyn FnOnce(&[u8 ]) -> Vec<u8>>

type HArg = (Self::HashFn ,)

const HASHER_METADATA: &'static [StorageHasher ]

fn final_key<KArg: EncodeLikeTuple<Self::KArg> + TupleToEncodedIter>(
key: KArg
) -> Vec<u8>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn migrate_key<KArg: EncodeLikeTuple<Self::KArg> + TupleToEncodedIter>(
key: &KArg,
hash_fns: Self::HArg
) -> Vec<u8>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn decode_final_key(key_material: &[u8 ]) -> Result<(Self::Key, &[u8 ]), Error>

impl<Hasher, KeyType> RefUnwindSafe for Key<Hasher, KeyType> where
Hasher: RefUnwindSafe,
KeyType: RefUnwindSafe,

impl<Hasher, KeyType> Send for Key<Hasher, KeyType> where
Hasher: Send,
KeyType: Send,

impl<Hasher, KeyType> Sync for Key<Hasher, KeyType> where
Hasher: Sync,
KeyType: Sync,

impl<Hasher, KeyType> Unpin for Key<Hasher, KeyType> where
Hasher: Unpin,
KeyType: Unpin,

impl<Hasher, KeyType> UnwindSafe for Key<Hasher, KeyType> where
Hasher: UnwindSafe,
KeyType: UnwindSafe,

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

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

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

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

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

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

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

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

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> MaybeRefUnwindSafe for T where
T: RefUnwindSafe,