Struct CIP25Metadata

pub struct CIP25Metadata(/* private fields */);

This is the entire metadata schema for CIP-25 It can be parsed by passing in the CBOR bytes of the entire transaction metadata or by passing in an existing Metadata struct. Parsing from CBOR bytes should be marginally faster.

Implementations

impl CIP25Metadata

pub fn to_metadata(&self) -> Result<Metadata, JsError>

Create a Metadata containing only the CIP25 schema

pub fn from_metadata(metadata: &Metadata) -> Result<CIP25Metadata, JsError>

Read the CIP25 schema from a Metadata. Ignores all other data besides CIP25 Can fail if the Metadata does not conform to CIP25

pub fn add_to_metadata(&self, metadata: &mut Metadata) -> Result<(), JsError>

Add to an existing metadata (could be empty) the full CIP25 metadata

impl CIP25Metadata

pub fn to_json(&self) -> Result<String, JsError>

pub fn to_js_value(&self) -> Result<JsValue, JsError>

pub fn from_json(json: &str) -> Result<CIP25Metadata, JsError>

impl CIP25Metadata

pub fn to_cbor_bytes(&self) -> Vec<u8>

Serialize to CBOR bytes compatible with tx metadata Does not guarantee any specific type of CBOR format and should NOT be used with round-tripping. It will ignore all non-CIP25 keys. Use cml_cip25::metadate crate for round-tripping metadata.

pub fn from_cbor_bytes(data: Vec<u8>) -> Result<CIP25Metadata, JsValue>

Deserialize from CBOR bytes compatible with tx metadata Does not guarantee any specific type of CBOR format and should NOT be used with round-tripping. It will ignore all non-CIP25 keys. Use cml_cip25::metadate crate for round-tripping metadata.

pub fn key_721(&self) -> CIP25LabelMetadata

The core details of the CIP25 spec

pub fn new(key_721: &CIP25LabelMetadata) -> CIP25Metadata

Trait Implementations

impl AsRef<CIP25Metadata> for CIP25Metadata

fn as_ref(&self) -> &CIP25Metadata

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CIP25Metadata

fn clone(&self) -> CIP25Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CIP25Metadata

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

Formats the value using the given formatter.

impl From<CIP25Metadata> for CIP25Metadata

fn from(native: CIP25Metadata) -> CIP25Metadata

Converts to this type from the input type.

impl From<CIP25Metadata> for JsValue

fn from(value: CIP25Metadata) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for CIP25Metadata

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> CIP25Metadata

Recover a Self from Self::Abi.

impl Into<CIP25Metadata> for CIP25Metadata

fn into(self) -> CIP25Metadata

Converts this type into the (usually inferred) input type.

impl IntoWasmAbi for CIP25Metadata

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for CIP25Metadata

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<CIP25Metadata>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <CIP25Metadata as LongRefFromWasmAbi>::Abi, ) -> <CIP25Metadata as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for CIP25Metadata

fn is_none(abi: &<CIP25Metadata as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for CIP25Metadata

fn none() -> <CIP25Metadata as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for CIP25Metadata

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<CIP25Metadata>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <CIP25Metadata as RefFromWasmAbi>::Abi, ) -> <CIP25Metadata as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for CIP25Metadata

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<CIP25Metadata>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <CIP25Metadata as RefMutFromWasmAbi>::Abi, ) -> <CIP25Metadata as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for CIP25Metadata

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value( value: JsValue, ) -> Result<CIP25Metadata, <CIP25Metadata as TryFromJsValue>::Error>

Performs the conversion.

impl VectorFromWasmAbi for CIP25Metadata

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <CIP25Metadata as VectorFromWasmAbi>::Abi, ) -> Box<[CIP25Metadata]>

impl VectorIntoWasmAbi for CIP25Metadata

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[CIP25Metadata]>, ) -> <CIP25Metadata as VectorIntoWasmAbi>::Abi