Struct sui_types::Identifier

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

An owned identifier.

For more details, see the module level documentation.

Implementations

impl Identifier

pub fn new(s: impl Into<Box<str>>) -> Result<Identifier, Error>

Creates a new Identifier instance.

pub fn is_valid(s: impl AsRef<str>) -> bool

Returns true if this string is a valid identifier.

pub fn is_self(&self) -> bool

Returns if this identifier is “”. TODO: remove once we fully separate CompiledScript & CompiledModule.

pub fn from_utf8(vec: Vec<u8>) -> Result<Identifier, Error>

Converts a vector of bytes to an Identifier.

pub fn as_ident_str(&self) -> &IdentStr

Creates a borrowed version of self.

pub fn into_string(self) -> String

Converts this Identifier into a String.

This is not implemented as a From trait to discourage automatic conversions – these conversions should not typically happen.

pub fn into_bytes(self) -> Vec<u8>

Converts this Identifier into a UTF-8-encoded byte sequence.

Methods from Deref<Target = IdentStr>

pub fn len(&self) -> usize

Returns the length of self in bytes.

pub fn is_empty(&self) -> bool

Returns true if self has a length of zero bytes.

pub fn as_str(&self) -> &str

Converts self to a &str.

This is not implemented as a From trait to discourage automatic conversions – these conversions should not typically happen.

pub fn as_bytes(&self) -> &[u8]

Converts self to a byte slice.

pub fn abstract_size_for_gas_metering(&self) -> GasQuantity<AbstractMemoryUnit>

Returns the abstract size of the struct TODO (ade): use macro to enfornce determinism

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Identifier

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Identifier, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Identifier, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Arbitrary for Identifier

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Identifier>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_: ()) -> <Identifier as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl AsRef<IdentStr> for Identifier

fn as_ref(&self) -> &IdentStr

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

impl Borrow<IdentStr> for Identifier

fn borrow(&self) -> &IdentStr

Immutably borrows from an owned value.

impl Clone for Identifier

fn clone(&self) -> Identifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl Deref for Identifier

type Target = IdentStr

The resulting type after dereferencing.

fn deref(&self) -> &IdentStr

Dereferences the value.

impl<'de> Deserialize<'de> for Identifier

fn deserialize<__D>( __deserializer: __D ) -> Result<Identifier, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Identifier

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

Formats the value using the given formatter.

impl From<&IdentStr> for Identifier

fn from(ident_str: &IdentStr) -> Identifier

Converts to this type from the input type.

impl FromStr for Identifier

type Err = Error

The associated error which can be returned from parsing.

fn from_str(data: &str) -> Result<Identifier, Error>

Parses a string s to return a value of this type.

impl Hash for Identifier

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Identifier

fn cmp(&self, other: &Identifier) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Identifier

fn eq(&self, other: &Identifier) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Identifier

fn partial_cmp(&self, other: &Identifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Identifier

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Identifier

impl StructuralPartialEq for Identifier