Struct RawObjectId

pub struct RawObjectId { /* private fields */ }

Represents an Object ID using a packed 12-byte representation

Each object id in screeps is represented by a Mongo GUID, which, while not guaranteed, is unlikely to change. This takes advantage of that by storing a packed representation.

Ordering

To facilitate use as a key in a BTreeMap or other similar data structures, ObjectId implements PartialOrd and Ord.

RawObjectId’s are ordered by the corresponding order of their underlying byte values. See ObjectId documentation for more information.

Implementations

impl RawObjectId

pub const fn from_packed(packed: u128) -> Self

Creates an object ID from its packed representation.

The input to this function is the bytes representing the up-to-24 hex digits in the object id.

pub fn to_array_string(&self) -> ArrayString<24>

Formats this object ID as a string on the stack.

This is equivalent to ToString::to_string, but involves no allocation.

Trait Implementations

impl Clone for RawObjectId

fn clone(&self) -> RawObjectId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawObjectId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RawObjectId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RawObjectId

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

Formats the value using the given formatter.

impl<T> From<ObjectId<T>> for RawObjectId

fn from(id: ObjectId<T>) -> Self

Converts to this type from the input type.

impl From<RawObjectId> for ArrayString<24>

fn from(id: RawObjectId) -> Self

Converts to this type from the input type.

impl<T> From<RawObjectId> for ObjectId<T>

fn from(raw: RawObjectId) -> Self

Converts to this type from the input type.

impl From<RawObjectId> for String

fn from(id: RawObjectId) -> Self

Converts to this type from the input type.

impl From<RawObjectId> for u128

fn from(id: RawObjectId) -> Self

Converts to this type from the input type.

impl From<u128> for RawObjectId

fn from(packed: u128) -> Self

Converts to this type from the input type.

impl FromStr for RawObjectId

type Err = RawObjectIdParseError

The associated error which can be returned from parsing.

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

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

impl Hash for RawObjectId

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 Ord for RawObjectId

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

Restrict a value to a certain interval.

impl<T> PartialEq<ObjectId<T>> for RawObjectId

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

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

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

fn partial_cmp(&self, other: &ObjectId<T>) -> 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<T> PartialOrd<RawObjectId> for ObjectId<T>

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

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<JsString> for RawObjectId

type Error = RawObjectIdParseError

The type returned in the event of a conversion error.

fn try_from(js_id: JsString) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for RawObjectId

impl Eq for RawObjectId

impl StructuralPartialEq for RawObjectId