Struct Metadata

pub struct Metadata { /* private fields */ }

Metadata wrapper around the runtime metadata. Offers some extra features, such as direct pallets, events and error access.

Implementations

impl Metadata

pub fn pallets(&self) -> impl Iterator<Item = PalletMetadata<'_>>

An iterator over all of the available pallets.

pub fn pallet_by_index(&self, variant_index: u8) -> Option<PalletMetadata<'_>>

Access a pallet given its encoded variant index.

pub fn pallet_by_name(&self, pallet_name: &str) -> Option<PalletMetadata<'_>>

Access a pallet given its name.

pub fn ty(&self) -> &<PortableForm as Form>::Type

Return the type of the Runtime.

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

Return the DispatchError type ID if it exists.

pub fn types(&self) -> &PortableRegistry

Return the type registry embedded within the metadata.

pub fn resolve_type(&self, id: u32) -> Option<&Type<PortableForm>>

Resolve a type definition.

pub fn runtime_metadata(&self) -> &RuntimeMetadataLastVersion

Exposes the runtime metadata.

pub fn extrinsic(&self) -> &ExtrinsicMetadata<PortableForm>

Return details about the extrinsic format.

pub fn runtime_api_traits( &self, ) -> impl ExactSizeIterator<Item = RuntimeApiMetadata<'_>>

An iterator over all of the runtime APIs.

pub fn runtime_api_trait_by_name( &self, name: &str, ) -> Option<RuntimeApiMetadata<'_>>

Access a runtime API trait given its name.

pub fn outer_enums(&self) -> &OuterEnums<PortableForm>

Return the outer enums types as found in the runtime.

pub fn custom(&self) -> &CustomMetadata<PortableForm>

Returns the custom types of the metadata.

pub fn pretty_format(&self) -> Result<String, FromUtf8Error>

impl Metadata

Err wrappers around option.

pub fn pallet_by_name_err( &self, name: &str, ) -> Result<PalletMetadata<'_>, MetadataError>

Identical to metadata.pallet_by_name(), but returns an error if the pallet is not found.

pub fn pallet_by_index_err( &self, index: u8, ) -> Result<PalletMetadata<'_>, MetadataError>

Identical to metadata.pallet_by_index(), but returns an error if the pallet is not found.

pub fn runtime_api_trait_by_name_err( &self, name: &str, ) -> Result<RuntimeApiMetadata<'_>, MetadataError>

Identical to metadata.runtime_api_trait_by_name(), but returns an error if the trait is not found.

impl Metadata

Get the storage keys corresponding to a storage

This is not part of subxt.

pub fn storage_value_key( &self, pallet: &'static str, storage_item: &'static str, ) -> Result<StorageKey, MetadataError>

pub fn storage_map_key<K: Encode>( &self, pallet: &'static str, storage_item: &'static str, map_key: K, ) -> Result<StorageKey, MetadataError>

pub fn storage_map_key_prefix( &self, pallet: &'static str, storage_item: &'static str, ) -> Result<StorageKey, MetadataError>

pub fn storage_double_map_key_prefix<K: Encode>( &self, storage_prefix: &'static str, storage_key_name: &'static str, first: K, ) -> Result<StorageKey, MetadataError>

pub fn storage_double_map_key<K: Encode, Q: Encode>( &self, pallet: &'static str, storage_item: &'static str, first_double_map_key: K, second_double_map_key: Q, ) -> Result<StorageKey, MetadataError>

impl Metadata

pub fn print_overview(&self)

pub fn print_pallets(&self)

pub fn print_pallets_with_calls(&self)

pub fn print_pallets_with_constants(&self)

pub fn print_pallet_with_storages(&self)

pub fn print_pallets_with_events(&self)

pub fn print_pallets_with_errors(&self)

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Decode for Metadata

fn decode<I: Input>(input: &mut I) -> 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 Encode for Metadata

fn encode_to<T: Output + ?Sized>(&self, dest: &mut T)

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>

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 TryFrom<RuntimeMetadataPrefixed> for Metadata

type Error = MetadataConversionError

The type returned in the event of a conversion error.

fn try_from(m: RuntimeMetadataPrefixed) -> Result<Self, Self::Error>

Performs the conversion.