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 arc(self) -> Arc<Metadata>

Metadata tends to be passed around wrapped in an Arc so that it can be cheaply cloned. This is a shorthand to return that.

pub fn decode_from(bytes: &[u8]) -> Result<Metadata, Error>

This is similar to<Metadata as codec::Decode>::decode(&mut bytes), except it is able to attempt to decode from several types.

• The default assumption is that metadata is encoded as frame_metadata::RuntimeMetadataPrefixed. This is the expected format that metadata is encoded into, and what the codec::Decode impl tries.
• if this fails, we also try to decode as frame_metadata::RuntimeMetadata.
• If this all fails, we finally will try to decode as frame_metadata::OpaqueMetadata.

pub fn from_v16(metadata: RuntimeMetadataV16) -> Result<Metadata, TryFromError>

Convert V16 metadata into Metadata.

pub fn from_v15(metadata: RuntimeMetadataV15) -> Result<Metadata, TryFromError>

Convert V15 metadata into Metadata.

pub fn from_v14(metadata: RuntimeMetadataV14) -> Result<Metadata, TryFromError>

Convert V14 metadata into Metadata.

pub fn from_v13( metadata: &RuntimeMetadataV13, types: &TypeRegistrySet<'_>, ) -> Result<Metadata, Error>

Convert V13 metadata into Metadata, given the necessary extra type information.

pub fn from_v12( metadata: &RuntimeMetadataV12, types: &TypeRegistrySet<'_>, ) -> Result<Metadata, Error>

Convert V12 metadata into Metadata, given the necessary extra type information.

pub fn from_v11( metadata: &RuntimeMetadataV11, types: &TypeRegistrySet<'_>, ) -> Result<Metadata, Error>

Convert V13 metadata into Metadata, given the necessary extra type information.

pub fn from_v10( metadata: &RuntimeMetadataV10, types: &TypeRegistrySet<'_>, ) -> Result<Metadata, Error>

Convert V13 metadata into Metadata, given the necessary extra type information.

pub fn from_v9( metadata: &RuntimeMetadataV9, types: &TypeRegistrySet<'_>, ) -> Result<Metadata, Error>

Convert V9 metadata into Metadata, given the necessary extra type information.

pub fn from_v8( metadata: &RuntimeMetadataV8, types: &TypeRegistrySet<'_>, ) -> Result<Metadata, Error>

Convert V8 metadata into Metadata, given the necessary extra type information.

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 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

An iterator over all of the available pallets.

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

Access a pallet given some call/extrinsic pallet index byte

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

Access a pallet given some event pallet index byte

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

Access a pallet given some error pallet index byte

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

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 type_hash(&self, id: u32) -> Option<[u8; 32]>

Get type hash for a type in the registry

Trait Implementations

impl ConstantEntryInfo for Metadata

fn constant_entries( &self, ) -> impl Iterator<Item = Entry<Cow<'_, str>, Cow<'_, str>>>

Iterate over all of the available Constants, returning Entry as we go.

fn constant_tuples(&self) -> impl Iterator<Item = (Cow<'_, str>, Cow<'_, str>)>

Iterate over all of the available Constants, returning a pair of (pallet_name, constant_name) as we go.

fn constants_in_pallet( &self, pallet: &str, ) -> impl Iterator<Item = Cow<'_, str>>

Iterate over all of the available constants in a given pallet.

impl ConstantTypeInfo for Metadata

type TypeId = u32

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

fn constant_info( &self, pallet_name: &str, constant_name: &str, ) -> Result<ConstantInfo<'_, <Metadata as ConstantTypeInfo>::TypeId>, ConstantInfoError<'_>>

Get information about a constant

impl CustomValueEntryInfo for Metadata

fn custom_values(&self) -> impl Iterator<Item = CustomValue<'_>>

Iterate over all of the available Custom Values, returning CustomValue as we go.

impl CustomValueTypeInfo for Metadata

type TypeId = u32

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

fn custom_value_info( &self, name: &str, ) -> Result<CustomValueInfo<'_, <Metadata as CustomValueTypeInfo>::TypeId>, CustomValueInfoError>

Get information about a constant

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Decode for Metadata

fn decode<I>(input: &mut I) -> Result<Metadata, Error>

where I: Input,

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 ExtrinsicTypeInfo for Metadata

type TypeId = u32

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

fn extrinsic_call_info_by_index( &self, pallet_index: u8, call_index: u8, ) -> Result<ExtrinsicCallInfo<'_, <Metadata as ExtrinsicTypeInfo>::TypeId>, ExtrinsicInfoError<'_>>

Get the information about the call data of a given extrinsic, given u8 indexes.

fn extrinsic_call_info_by_name( &self, pallet_name: &str, call_name: &str, ) -> Result<ExtrinsicCallInfo<'_, <Metadata as ExtrinsicTypeInfo>::TypeId>, ExtrinsicInfoError<'_>>

Get the information about the call data of a given extrinsic, given pallet and call name.

fn extrinsic_signature_info( &self, ) -> Result<ExtrinsicSignatureInfo<<Metadata as ExtrinsicTypeInfo>::TypeId>, ExtrinsicInfoError<'_>>

Get the information needed to decode or encode the extrinsic signature bytes.

fn extrinsic_extension_version_info( &self, ) -> Result<impl Iterator<Item = u8>, ExtrinsicInfoError<'_>>

Get the available transaction extension versions. Prior to runtimes supporting V5 extrinsics this should not return any entries. In runtimes supporting V5 extrinsics, 1 or more versions should be returned.

fn extrinsic_extension_info( &self, extension_version: Option<u8>, ) -> Result<ExtrinsicExtensionInfo<'_, <Metadata as ExtrinsicTypeInfo>::TypeId>, ExtrinsicInfoError<'_>>

Get the information needed to decode the transaction extensions.

impl RuntimeApiEntryInfo for Metadata

fn runtime_api_entries( &self, ) -> impl Iterator<Item = Entry<Cow<'_, str>, Cow<'_, str>>>

Iterate over all of the available Runtime Apis, returning Entry as we go.

fn runtime_api_tuples( &self, ) -> impl Iterator<Item = (Cow<'_, str>, Cow<'_, str>)>

Iterate over all of the available Runtime Apis, returning a pair of (trait_name, method_name) as we go.

fn runtime_apis_in_trait( &self, pallet: &str, ) -> impl Iterator<Item = Cow<'_, str>>

Iterate over all of the available Runtime Apis in a given trait.

impl RuntimeApiTypeInfo for Metadata

type TypeId = u32

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

fn runtime_api_info( &self, trait_name: &str, method_name: &str, ) -> Result<RuntimeApiInfo<'_, <Metadata as RuntimeApiTypeInfo>::TypeId>, RuntimeApiInfoError<'_>>

Get the information needed to encode/decode a specific Runtime API call

impl StorageEntryInfo for Metadata

fn storage_entries( &self, ) -> impl Iterator<Item = Entry<Cow<'_, str>, Cow<'_, str>>>

Iterate over all of the available Storage Entries, returning Entry as we go.

fn storage_tuples(&self) -> impl Iterator<Item = (Cow<'_, str>, Cow<'_, str>)>

Iterate over all of the available Storage Entries, returning a pair of (pallet_name, constant_name) as we go.

fn storage_in_pallet(&self, pallet: &str) -> impl Iterator<Item = Cow<'_, str>>

Iterate over all of the available Storage Entries in a given pallet.

impl StorageTypeInfo for Metadata

type TypeId = u32

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

fn storage_info( &self, pallet_name: &str, storage_entry: &str, ) -> Result<StorageInfo<'_, <Metadata as StorageTypeInfo>::TypeId>, StorageInfoError<'_>>

Get the information needed to decode a specific storage entry key/value.

impl TryFrom<RuntimeMetadataPrefixed> for Metadata

type Error = TryFromError

The type returned in the event of a conversion error.

fn try_from( value: RuntimeMetadataPrefixed, ) -> Result<Metadata, <Metadata as TryFrom<RuntimeMetadataPrefixed>>::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(m: RuntimeMetadataV14) -> Result<Metadata, TryFromError>

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<Metadata, TryFromError>

Performs the conversion.

impl TryFrom<RuntimeMetadataV16> for Metadata

type Error = TryFromError

The type returned in the event of a conversion error.

fn try_from(m: RuntimeMetadataV16) -> Result<Metadata, TryFromError>

Performs the conversion.

impl ViewFunctionEntryInfo for Metadata

fn view_function_entries( &self, ) -> impl Iterator<Item = Entry<Cow<'_, str>, Cow<'_, str>>>

Iterate over all of the available View Functions, returning Entry as we go.

fn view_function_tuples( &self, ) -> impl Iterator<Item = (Cow<'_, str>, Cow<'_, str>)>

Iterate over all of the available View Functions, returning a pair of (pallet_name, view_function_name) as we go.

fn view_functions_in_pallet( &self, pallet: &str, ) -> impl Iterator<Item = Cow<'_, str>>

Iterate over all of the available View Functions in a given pallet.

impl ViewFunctionTypeInfo for Metadata

type TypeId = u32

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

fn view_function_info( &self, pallet_name: &str, function_name: &str, ) -> Result<ViewFunctionInfo<'_, <Metadata as ViewFunctionTypeInfo>::TypeId>, ViewFunctionInfoError<'_>>

Get the information needed to decode a specific View Function.