Struct WithConfig

pub struct WithConfig<ConfigValue, Extra = ()>
where
    ConfigValue: ConfigValueMarker,
{
    pub config: ConfigValue,
    pub extra: Extra,
}

The WithConfig is a create and restore strategy. It facilitates setting the asset’s properties that can be later inspected via the corresponding inspect strategies. The provided asset’s properties are considered its config. Every inspect strategy can be used to create a config value.

For instance, one can use WithConfig to restore an asset to the given owner using the Owner inspect strategy:

NftEngine::restore(WithConfig::from(Owner::with_config_value(OWNER_ACCOUNT)))

The extra parameters can be supplied to provide additional context to the operation. They’re required for creation operation as they provide the id assignment approach, but they’re optional for the restoring operation.

For instance, one can use WithConfig to create an asset with a predefined id this way:

NftEngine::create(WithConfig::new(
    Owner::with_config_value(OWNER_ACCOUNT),
    PredefinedId::from(ASSET_ID),
))

Note: you can use several config values by providing a tuple of them:

NftEngine::create(WithConfig::new(
    (
         Owner::with_config_value(OWNER_ACCOUNT),
         Admin::with_config_value(ADMIN_ACCOUNT),
    ),
    PredefinedId::from(ASSET_ID),
))

Fields

config: ConfigValue

extra: Extra

Implementations

impl<ConfigValue> WithConfig<ConfigValue>

where ConfigValue: ConfigValueMarker,

pub fn from(config: ConfigValue) -> WithConfig<ConfigValue>

impl<ConfigValue, Extra> WithConfig<ConfigValue, Extra>

where ConfigValue: ConfigValueMarker,

pub fn new(config: ConfigValue, extra: Extra) -> WithConfig<ConfigValue, Extra>

Trait Implementations

impl<ConfigValue, Extra> Clone for WithConfig<ConfigValue, Extra>

where ConfigValue: Clone + ConfigValueMarker, Extra: Clone,

fn clone(&self) -> WithConfig<ConfigValue, Extra>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ConfigValue, Assignment> CreateStrategy for WithConfig<ConfigValue, Assignment>

where ConfigValue: ConfigValueMarker, Assignment: IdAssignment,

type Success = <Assignment as IdAssignment>::ReportedId

This type represents a successful asset creation. It will be in the Result type of the Create::create function.

impl<ConfigValue, Extra> Debug for WithConfig<ConfigValue, Extra>

where ConfigValue: ConfigValueMarker + Debug, Extra: Debug,

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

Formats the value using the given formatter.

impl<ConfigValue, Extra> Decode for WithConfig<ConfigValue, Extra>

where ConfigValue: ConfigValueMarker + Decode, Extra: Decode,

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<WithConfig<ConfigValue, Extra>, Error>

where __CodecInputEdqy: 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<ConfigValue, Extra> Encode for WithConfig<ConfigValue, Extra>

where ConfigValue: ConfigValueMarker + Encode, Extra: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

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<ConfigValue, Extra> MaxEncodedLen for WithConfig<ConfigValue, Extra>

where ConfigValue: ConfigValueMarker + MaxEncodedLen, Extra: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<ConfigValue, Extra> PartialEq for WithConfig<ConfigValue, Extra>

where ConfigValue: PartialEq + ConfigValueMarker, Extra: PartialEq,

fn eq(&self, other: &WithConfig<ConfigValue, Extra>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<ConfigValue, Extra> RestoreStrategy for WithConfig<ConfigValue, Extra>

where ConfigValue: ConfigValueMarker,

type Success = ()

This type represents a successful asset restoration. It will be in the Result type of the Restore::restore function.

impl<ConfigValue, Extra> TypeInfo for WithConfig<ConfigValue, Extra>

where ConfigValue: ConfigValueMarker + TypeInfo + 'static, Extra: TypeInfo + 'static,

type Identity = WithConfig<ConfigValue, Extra>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<ConfigValue, Extra> EncodeLike for WithConfig<ConfigValue, Extra>

where ConfigValue: ConfigValueMarker + Encode, Extra: Encode,

impl<ConfigValue, Extra> Eq for WithConfig<ConfigValue, Extra>

where ConfigValue: Eq + ConfigValueMarker, Extra: Eq,

impl<ConfigValue, Extra> StructuralPartialEq for WithConfig<ConfigValue, Extra>

where ConfigValue: ConfigValueMarker,