Struct NameRecord

#[non_exhaustive]
pub struct NameRecord {
    pub id: Option<String>,
    pub name: Option<String>,
    pub registration_nft_id: Option<String>,
    pub expiration_timestamp: Option<Timestamp>,
    pub target_address: Option<String>,
    pub data: BTreeMap<String, String>,
}

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>

Id of this record.

Note that records are stored on chain as dynamic fields of the type Field<Domain,NameRecord>.

name: Option<String>

The SuiNS name of this record

registration_nft_id: Option<String>

The ID of the RegistrationNFT assigned to this record.

The owner of the corresponding RegistrationNFT has the rights to be able to change and adjust the target_address of this domain.

It is possible that the ID changes if the record expires and is purchased by someone else.

expiration_timestamp: Option<Timestamp>

Timestamp when the record expires.

This is either the expiration of the record itself or the expiration of this record’s parent if this is a leaf record.

target_address: Option<String>

The target address that this name points to

data: BTreeMap<String, String>

Additional data which may be stored in a record

Implementations

impl NameRecord

pub const ID_FIELD: &'static MessageField

pub const NAME_FIELD: &'static MessageField

pub const REGISTRATION_NFT_ID_FIELD: &'static MessageField

pub const EXPIRATION_TIMESTAMP_FIELD: &'static MessageField

pub const TARGET_ADDRESS_FIELD: &'static MessageField

pub const DATA_FIELD: &'static MessageField

impl NameRecord

pub fn path_builder() -> NameRecordFieldPathBuilder

impl NameRecord

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 name_opt_mut(&mut self) -> Option<&mut String>

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

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

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

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

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

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

Sets name with the provided value.

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

Sets name with the provided value.

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

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

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

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

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

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

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

Sets registration_nft_id with the provided value.

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

Sets registration_nft_id with the provided value.

pub fn expiration_timestamp_opt_mut(&mut self) -> Option<&mut Timestamp>

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

pub fn expiration_timestamp_mut(&mut self) -> &mut Timestamp

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

pub fn expiration_timestamp_opt(&self) -> Option<&Timestamp>

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

pub fn set_expiration_timestamp<T: Into<Timestamp>>(&mut self, field: T)

Sets expiration_timestamp with the provided value.

pub fn with_expiration_timestamp<T: Into<Timestamp>>(self, field: T) -> Self

Sets expiration_timestamp with the provided value.

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

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

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

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

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

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

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

Sets target_address with the provided value.

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

Sets target_address with the provided value.

pub fn data(&self) -> &BTreeMap<String, String>

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

pub fn data_mut(&mut self) -> &mut BTreeMap<String, String>

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

pub fn set_data(&mut self, field: BTreeMap<String, String>)

Sets data with the provided value.

pub fn with_data(self, field: BTreeMap<String, String>) -> Self

Sets data with the provided value.

impl NameRecord

pub fn id(&self) -> &str

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

pub fn name(&self) -> &str

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

pub fn registration_nft_id(&self) -> &str

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

pub fn target_address(&self) -> &str

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

Trait Implementations

impl Clone for NameRecord

fn clone(&self) -> NameRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NameRecord

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

Formats the value using the given formatter.

impl Default for NameRecord

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NameRecord

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for NameRecord

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 NameRecord

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

impl PartialEq for NameRecord

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

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 NameRecord