Struct Flags 

pub struct Flags { /* private fields */ }

Bitfield representation of asset flags.

Implementations

impl Flags

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl Flags

pub const fn into_bytes(self) -> [u8; 1]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 1]) -> Self

Converts the given bytes directly into the bitfield struct.

impl Flags

pub fn asset_lvl_frozen(&self) -> <bool as Specifier>::InOut

Returns the value of asset_lvl_frozen. Frozen at the asset level by the leaf delegate.

pub fn asset_lvl_frozen_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of asset_lvl_frozen.

#Errors

If the returned value contains an invalid bit pattern for asset_lvl_frozen. Frozen at the asset level by the leaf delegate.

pub fn with_asset_lvl_frozen(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of asset_lvl_frozen set to the given value.

#Panics

If the given value is out of bounds for asset_lvl_frozen. Frozen at the asset level by the leaf delegate.

pub fn with_asset_lvl_frozen_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of asset_lvl_frozen set to the given value.

#Errors

If the given value is out of bounds for asset_lvl_frozen. Frozen at the asset level by the leaf delegate.

pub fn set_asset_lvl_frozen(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of asset_lvl_frozen to the given value.

#Panics

If the given value is out of bounds for asset_lvl_frozen. Frozen at the asset level by the leaf delegate.

pub fn set_asset_lvl_frozen_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of asset_lvl_frozen to the given value.

#Errors

If the given value is out of bounds for asset_lvl_frozen. Frozen at the asset level by the leaf delegate.

pub fn permanent_lvl_frozen(&self) -> <bool as Specifier>::InOut

Returns the value of permanent_lvl_frozen. Frozen by the mpl-core collection permanent freeze delegate.

pub fn permanent_lvl_frozen_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of permanent_lvl_frozen.

#Errors

If the returned value contains an invalid bit pattern for permanent_lvl_frozen. Frozen by the mpl-core collection permanent freeze delegate.

pub fn with_permanent_lvl_frozen( self, new_val: <bool as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of permanent_lvl_frozen set to the given value.

#Panics

If the given value is out of bounds for permanent_lvl_frozen. Frozen by the mpl-core collection permanent freeze delegate.

pub fn with_permanent_lvl_frozen_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of permanent_lvl_frozen set to the given value.

#Errors

If the given value is out of bounds for permanent_lvl_frozen. Frozen by the mpl-core collection permanent freeze delegate.

pub fn set_permanent_lvl_frozen(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of permanent_lvl_frozen to the given value.

#Panics

If the given value is out of bounds for permanent_lvl_frozen. Frozen by the mpl-core collection permanent freeze delegate.

pub fn set_permanent_lvl_frozen_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of permanent_lvl_frozen to the given value.

#Errors

If the given value is out of bounds for permanent_lvl_frozen. Frozen by the mpl-core collection permanent freeze delegate.

pub fn non_transferable(&self) -> <bool as Specifier>::InOut

Returns the value of non_transferable. Set to permanently non-transferable (soulbound).

pub fn non_transferable_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of non_transferable.

#Errors

If the returned value contains an invalid bit pattern for non_transferable. Set to permanently non-transferable (soulbound).

pub fn with_non_transferable(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of non_transferable set to the given value.

#Panics

If the given value is out of bounds for non_transferable. Set to permanently non-transferable (soulbound).

pub fn with_non_transferable_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of non_transferable set to the given value.

#Errors

If the given value is out of bounds for non_transferable. Set to permanently non-transferable (soulbound).

pub fn set_non_transferable(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of non_transferable to the given value.

#Panics

If the given value is out of bounds for non_transferable. Set to permanently non-transferable (soulbound).

pub fn set_non_transferable_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of non_transferable to the given value.

#Errors

If the given value is out of bounds for non_transferable. Set to permanently non-transferable (soulbound).

pub fn empty_bits(&self) -> <B5 as Specifier>::InOut

Returns the value of empty_bits. Unused flags for future asset-level usage.

pub fn empty_bits_or_err( &self, ) -> Result<<B5 as Specifier>::InOut, InvalidBitPattern<<B5 as Specifier>::Bytes>>

Returns the value of empty_bits.

#Errors

If the returned value contains an invalid bit pattern for empty_bits. Unused flags for future asset-level usage.

pub fn with_empty_bits(self, new_val: <B5 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of empty_bits set to the given value.

#Panics

If the given value is out of bounds for empty_bits. Unused flags for future asset-level usage.

pub fn with_empty_bits_checked( self, new_val: <B5 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of empty_bits set to the given value.

#Errors

If the given value is out of bounds for empty_bits. Unused flags for future asset-level usage.

pub fn set_empty_bits(&mut self, new_val: <B5 as Specifier>::InOut)

Sets the value of empty_bits to the given value.

#Panics

If the given value is out of bounds for empty_bits. Unused flags for future asset-level usage.

pub fn set_empty_bits_checked( &mut self, new_val: <B5 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of empty_bits to the given value.

#Errors

If the given value is out of bounds for empty_bits. Unused flags for future asset-level usage.

Trait Implementations

impl CheckFillsUnalignedBits for Flags

type CheckType = [(); 1]

impl Clone for Flags

fn clone(&self) -> Flags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl Default for Flags

fn default() -> Flags

Returns the “default value” for a type.

impl PartialEq for Flags

fn eq(&self, other: &Flags) -> 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 Copy for Flags

impl Eq for Flags

impl StructuralPartialEq for Flags