Struct iota_types::base_types::ObjectID

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

Implementations

impl ObjectID

pub const LENGTH: usize = 32usize

The number of bytes in an address.

pub const ZERO: Self = _

Hex address: 0x0

pub const MAX: Self = _

pub const fn new(obj_id: [u8; 32]) -> Self

Create a new ObjectID

pub const fn from_address(addr: AccountAddress) -> Self

Const fn variant of <ObjectID as From<AccountAddress>>::from

pub fn random() -> Self

Return a random ObjectID.

pub fn random_from_rng<R>(rng: &mut R) -> Self

where R: AllowedRng,

Return a random ObjectID from a given RNG.

pub fn to_vec(&self) -> Vec<u8>

Return the underlying bytes buffer of the ObjectID.

pub fn from_bytes<T: AsRef<[u8]>>(bytes: T) -> Result<Self, ObjectIDParseError>

Parse the ObjectID from byte array or buffer.

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

Return the underlying bytes array of the ObjectID.

pub const fn from_single_byte(byte: u8) -> ObjectID

Make an ObjectID with padding 0s before the single byte.

pub fn from_hex_literal(literal: &str) -> Result<Self, ObjectIDParseError>

Convert from hex string to ObjectID where the string is prefixed with 0x Padding 0s if the string is too short.

pub fn derive_id(digest: TransactionDigest, creation_num: u64) -> Self

Create an ObjectID from TransactionDigest and creation_num. Caller is responsible for ensuring that creation_num is fresh

pub fn advance(&self, step: usize) -> Result<ObjectID, Error>

Incremenent the ObjectID by usize IDs, assuming the ObjectID hex is a number represented as an array of bytes

pub fn next_increment(&self) -> Result<ObjectID, Error>

Increment the ObjectID by one, assuming the ObjectID hex is a number represented as an array of bytes

pub fn in_range(offset: ObjectID, count: u64) -> Result<Vec<ObjectID>, Error>

Create count object IDs starting with one at offset

pub fn to_hex_uncompressed(&self) -> String

Return the full hex string with 0x prefix without removing trailing 0s. Prefer this over [fn to_hex_literal] if the string needs to be fully preserved.

pub fn is_clock(&self) -> bool

Methods from Deref<Target = AccountAddress>

pub const LENGTH: usize = 32usize

pub const ZERO: AccountAddress = _

pub const ONE: AccountAddress = _

pub const TWO: AccountAddress = _

pub fn to_canonical_string(&self, with_prefix: bool) -> String

Return a canonical string representation of the address Addresses are hex-encoded lowercase values of length ADDRESS_LENGTH (16, 20, or 32 depending on the Move platform) e.g., 0000000000000000000000000000000a, not 0x0000000000000000000000000000000a, 0xa, or 0xA Note: this function is guaranteed to be stable, and this is suitable for use inside Move native functions or the VM. However, one can pass with_prefix=true to get its representation with the 0x prefix.

pub fn to_canonical_display(&self, with_prefix: bool) -> impl Display

Implements Display for the address, with the prefix 0x if with_prefix is true.

pub fn short_str_lossless(&self) -> String

pub fn to_vec(&self) -> Vec<u8>

pub fn to_hex_literal(&self) -> String

pub fn to_hex(&self) -> String

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

TODO (ade): use macro to enfornce determinism

Methods from Deref<Target = [u8; 32]>

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into an array of ASCII characters, or returns None if any of the characters is non-ASCII.

Examples

#![feature(ascii_char)]
#![feature(const_option)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into an array of ASCII characters, without checking whether they’re valid.

Safety

Every byte in the array must be in 0..=127, or else this is UB.

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn each_ref(&self) -> [&T; N]

Borrows each element and returns an array of references with the same size as self.

Example

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

Trait Implementations

impl AsRef<[u8]> for ObjectID

fn as_ref(&self) -> &[u8]

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

impl Clone for ObjectID

fn clone(&self) -> ObjectID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectID

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

Formats the value using the given formatter.

impl Deref for ObjectID

type Target = AccountAddress

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for ObjectID

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ObjectID

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

Formats the value using the given formatter.

impl From<AccountAddress> for ObjectID

fn from(address: AccountAddress) -> Self

Converts to this type from the input type.

impl From<IotaAddress> for ObjectID

fn from(address: IotaAddress) -> ObjectID

Converts to this type from the input type.

impl From<ObjectID> for AccountAddress

fn from(obj_id: ObjectID) -> Self

Converts to this type from the input type.

impl From<ObjectID> for IotaAddress

fn from(object_id: ObjectID) -> IotaAddress

Converts to this type from the input type.

impl From<ObjectID> for ObjectId

fn from(value: ObjectID) -> Self

Converts to this type from the input type.

impl From<ObjectId> for ObjectID

fn from(value: ObjectId) -> Self

Converts to this type from the input type.

impl FromStr for ObjectID

fn from_str(s: &str) -> Result<Self, ObjectIDParseError>

Parse ObjectID from hex string with or without 0x prefix, pad with 0s if needed.

type Err = ObjectIDParseError

The associated error which can be returned from parsing.

impl Hash for ObjectID

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

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 JsonSchema for ObjectID

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl MoveTypeTagTrait for ObjectID

fn get_type_tag() -> TypeTag

impl Ord for ObjectID

fn cmp(&self, other: &ObjectID) -> 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<ObjectID> for Owner

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

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ObjectID

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for ObjectID

fn try_from(bytes: &[u8]) -> Result<ObjectID, ObjectIDParseError>

Tries to convert the provided byte array into ObjectID.

type Error = ObjectIDParseError

The type returned in the event of a conversion error.

impl TryFrom<Vec<u8>> for ObjectID

fn try_from(bytes: Vec<u8>) -> Result<ObjectID, ObjectIDParseError>

Tries to convert the provided byte buffer into ObjectID.

type Error = ObjectIDParseError

The type returned in the event of a conversion error.

impl Copy for ObjectID

impl Eq for ObjectID

impl StructuralPartialEq for ObjectID