Struct Metadata

pub struct Metadata { /* private fields */ }

Node metadata. This can be constructed by providing some compatible frame_metadata which is then decoded into this. We aim to preserve all of the existing information in the incoming metadata while optimizing the format a little for Subxt’s use cases.

Implementations

impl Metadata

pub fn types(&self) -> &PortableRegistry

Access the underlying type registry.

pub fn types_mut(&mut self) -> &mut PortableRegistry

Mutable access to the underlying type registry.

pub fn runtime_ty(&self) -> u32

The type ID of the Runtime type.

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

The type ID of the DispatchError type, if it exists.

pub fn extrinsic(&self) -> &ExtrinsicMetadata

Return details about the extrinsic format.

pub fn outer_enums(&self) -> OuterEnumsMetadata

Return details about the outer enums.

pub fn pallets(&self) -> impl ExactSizeIterator<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 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 custom(&self) -> CustomMetadata<'_>

Returns custom user defined types

pub fn hasher(&self) -> MetadataHasher<'_>

Obtain a unique hash representing this metadata or specific parts of it.

pub fn retain<F, G>(&mut self, pallet_filter: F, api_filter: G)

where F: FnMut(&str) -> bool, G: FnMut(&str) -> bool,

Filter out any pallets and/or runtime_apis that we don’t want to keep, retaining only those that we do. Note: only filter by pallets will not lead to significant metadata size reduction because the return types are kept to ensure that those can be decoded.

pub fn type_hash(&self, id: u32) -> Option<[u8; 32]>

Get type hash for a type in the registry

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy 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 ExtrinsicTypeInfo for Metadata

type TypeId = u32

The type of type IDs that we are using to obtain type information.

fn get_call_info( &self, pallet_index: u8, call_index: u8, ) -> Result<ExtrinsicCallInfo<'_, Self::TypeId>, ExtrinsicInfoError<'_>>

Get the information about the call data of a given extrinsic.

fn get_signature_info( &self, ) -> Result<ExtrinsicSignatureInfo<Self::TypeId>, ExtrinsicInfoError<'_>>

Get the information needed to decode the extrinsic signature bytes.

fn get_extension_info( &self, extension_version: Option<u8>, ) -> Result<ExtrinsicExtensionInfo<'_, Self::TypeId>, ExtrinsicInfoError<'_>>

Get the information needed to decode the transaction extensions.

impl From<Metadata> for RuntimeMetadataPrefixed

fn from(value: Metadata) -> Self

Converts to this type from the input type.

impl From<Metadata> for RuntimeMetadataV14

fn from(val: Metadata) -> Self

Converts to this type from the input type.

impl From<Metadata> for RuntimeMetadataV15

fn from(m: Metadata) -> Self

Converts to this type from the input type.

impl TryFrom<RuntimeMetadataPrefixed> for Metadata

type Error = TryFromError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<RuntimeMetadataV14> for Metadata

type Error = TryFromError

The type returned in the event of a conversion error.

fn try_from(value: RuntimeMetadataV14) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RuntimeMetadataV15> for Metadata

type Error = TryFromError

The type returned in the event of a conversion error.

fn try_from(m: RuntimeMetadataV15) -> Result<Self, TryFromError>

Performs the conversion.