Struct RegulatedCoinMetadata

#[non_exhaustive]
pub struct RegulatedCoinMetadata {
    pub id: Option<String>,
    pub coin_metadata_object: Option<String>,
    pub deny_cap_object: Option<String>,
    pub allow_global_pause: Option<bool>,
    pub variant: Option<u32>,
    pub coin_regulated_state: Option<i32>,
}

Information about a regulated coin, which indicates that it makes use of the transfer deny list.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

ObjectId of the 0x2::coin::RegulatedCoinMetadata object. Only present for coins that have not been migrated to CoinRegistry.

coin_metadata_object: Option<String>

The ID of the coin’s CoinMetadata or CoinData object.

deny_cap_object: Option<String>

The ID of the coin’s DenyCap object.

allow_global_pause: Option<bool>

Whether the coin can be globally paused

variant: Option<u32>

Variant of the regulated coin metadata

coin_regulated_state: Option<i32>

Indicates the coin’s regulated state.

Implementations

impl RegulatedCoinMetadata

pub const ID_FIELD: &'static MessageField

pub const COIN_METADATA_OBJECT_FIELD: &'static MessageField

pub const DENY_CAP_OBJECT_FIELD: &'static MessageField

pub const ALLOW_GLOBAL_PAUSE_FIELD: &'static MessageField

pub const VARIANT_FIELD: &'static MessageField

pub const COIN_REGULATED_STATE_FIELD: &'static MessageField

impl RegulatedCoinMetadata

pub fn path_builder() -> RegulatedCoinMetadataFieldPathBuilder

impl RegulatedCoinMetadata

pub const fn const_default() -> Self

pub fn id_opt_mut(&mut self) -> Option<&mut String>

If id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn id_mut(&mut self) -> &mut String

Returns a mutable reference to id. If the field is unset, it is first initialized with the default value.

pub fn id_opt(&self) -> Option<&str>

If id is set, returns Some with the value; otherwise returns None.

pub fn set_id<T: Into<String>>(&mut self, field: T)

Sets id with the provided value.

pub fn with_id<T: Into<String>>(self, field: T) -> Self

Sets id with the provided value.

pub fn coin_metadata_object_opt_mut(&mut self) -> Option<&mut String>

If coin_metadata_object is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn coin_metadata_object_mut(&mut self) -> &mut String

Returns a mutable reference to coin_metadata_object. If the field is unset, it is first initialized with the default value.

pub fn coin_metadata_object_opt(&self) -> Option<&str>

If coin_metadata_object is set, returns Some with the value; otherwise returns None.

pub fn set_coin_metadata_object<T: Into<String>>(&mut self, field: T)

Sets coin_metadata_object with the provided value.

pub fn with_coin_metadata_object<T: Into<String>>(self, field: T) -> Self

Sets coin_metadata_object with the provided value.

pub fn deny_cap_object_opt_mut(&mut self) -> Option<&mut String>

If deny_cap_object is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn deny_cap_object_mut(&mut self) -> &mut String

Returns a mutable reference to deny_cap_object. If the field is unset, it is first initialized with the default value.

pub fn deny_cap_object_opt(&self) -> Option<&str>

If deny_cap_object is set, returns Some with the value; otherwise returns None.

pub fn set_deny_cap_object<T: Into<String>>(&mut self, field: T)

Sets deny_cap_object with the provided value.

pub fn with_deny_cap_object<T: Into<String>>(self, field: T) -> Self

Sets deny_cap_object with the provided value.

pub fn allow_global_pause_opt_mut(&mut self) -> Option<&mut bool>

If allow_global_pause is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn allow_global_pause_mut(&mut self) -> &mut bool

Returns a mutable reference to allow_global_pause. If the field is unset, it is first initialized with the default value.

pub fn allow_global_pause_opt(&self) -> Option<bool>

If allow_global_pause is set, returns Some with the value; otherwise returns None.

pub fn set_allow_global_pause<T: Into<bool>>(&mut self, field: T)

Sets allow_global_pause with the provided value.

pub fn with_allow_global_pause<T: Into<bool>>(self, field: T) -> Self

Sets allow_global_pause with the provided value.

pub fn variant_opt_mut(&mut self) -> Option<&mut u32>

If variant is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn variant_mut(&mut self) -> &mut u32

Returns a mutable reference to variant. If the field is unset, it is first initialized with the default value.

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

If variant is set, returns Some with the value; otherwise returns None.

pub fn set_variant<T: Into<u32>>(&mut self, field: T)

Sets variant with the provided value.

pub fn with_variant<T: Into<u32>>(self, field: T) -> Self

Sets variant with the provided value.

pub fn with_coin_regulated_state<T: Into<CoinRegulatedState>>( self, field: T, ) -> Self

Sets coin_regulated_state with the provided value.

impl RegulatedCoinMetadata

pub fn id(&self) -> &str

Returns the value of id, or the default value if id is unset.

pub fn coin_metadata_object(&self) -> &str

Returns the value of coin_metadata_object, or the default value if coin_metadata_object is unset.

pub fn deny_cap_object(&self) -> &str

Returns the value of deny_cap_object, or the default value if deny_cap_object is unset.

pub fn allow_global_pause(&self) -> bool

Returns the value of allow_global_pause, or the default value if allow_global_pause is unset.

pub fn variant(&self) -> u32

Returns the value of variant, or the default value if variant is unset.

pub fn coin_regulated_state(&self) -> CoinRegulatedState

Returns the enum value of coin_regulated_state, or the default if the field is unset or set to an invalid enum value.

pub fn set_coin_regulated_state(&mut self, value: CoinRegulatedState)

Sets coin_regulated_state to the provided enum value.

Trait Implementations

impl Clone for RegulatedCoinMetadata

fn clone(&self) -> RegulatedCoinMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegulatedCoinMetadata

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

Formats the value using the given formatter.

impl Default for RegulatedCoinMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RegulatedCoinMetadata

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RegulatedCoinMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for RegulatedCoinMetadata

const FIELDS: &'static [&'static MessageField]

impl PartialEq for RegulatedCoinMetadata

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RegulatedCoinMetadata