Struct ObjectId 

pub struct ObjectId<K> { /* private fields */ }

Identifies a single object in an object-centric log (OCEL).

Zero-cost #[repr(transparent)] wrapper carrying a PhantomData<K> kind marker. Structure-only: it names an entity, it does not resolve or validate the link. Graduate to wasm4pm to dereference it.

Implementations

impl<K> ObjectId<K>

pub const fn new(raw: u64) -> Self

Wraps a raw u64 as a typed ObjectId.

Examples

use wasm4pm_compat::ids::ObjectId;
enum Local {}
let id = ObjectId::<Local>::new(7);
assert_eq!(id.raw(), 7);

pub const fn raw(self) -> u64

Returns the underlying raw u64.

Examples

use wasm4pm_compat::ids::ObjectId;
enum Local {}
assert_eq!(ObjectId::<Local>::new(42).raw(), 42);

pub const fn into_inner(self) -> u64

Consumes self and returns the underlying raw u64 value.

Identical to raw; provided for newtype-wrapper ergonomics so callers can use the same into_inner() idiom across all ID kinds.

Examples

use wasm4pm_compat::ids::ObjectId;
enum Local {}
assert_eq!(ObjectId::<Local>::new(5).into_inner(), 5);

pub const fn as_inner(&self) -> &u64

Borrows the underlying raw u64 value.

Identical to AsRef but using the newtype-wrapper ergonomic name as_inner() so callers can use a consistent idiom across all ID kinds.

Examples

use wasm4pm_compat::ids::ObjectId;
enum Local {}
assert_eq!(*ObjectId::<Local>::new(9).as_inner(), 9);

Trait Implementations

impl<K> AsRef<u64> for ObjectId<K>

fn as_ref(&self) -> &u64

Borrows the underlying raw value without copying.

impl<K> Clone for ObjectId<K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K> Copy for ObjectId<K>

impl<K> Debug for ObjectId<K>

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

Formats the value using the given formatter.

impl<K> Display for ObjectId<K>

Displays the raw numeric value prefixed by the type name, e.g. EventId(7).

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

Formats the value using the given formatter.

impl<K> Eq for ObjectId<K>

impl<K> From<ObjectId<K>> for u64

fn from(id: ObjectId<K>) -> u64

Unwraps the typed id back to its raw primitive. Infallible.

impl<K> From<u64> for ObjectId<K>

fn from(raw: u64) -> Self

Wraps a raw primitive as a typed id. Infallible.

impl<K> FromStr for ObjectId<K>

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

Parses the decimal representation of the raw primitive.

Errors

Returns the same error as $raw::from_str when the string is not a valid decimal integer.

type Err = <u64 as FromStr>::Err

The associated error which can be returned from parsing.

impl<K> Hash for ObjectId<K>

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<K> NewFromRaw for ObjectId<K>

type Raw = u64

The underlying raw primitive (same as TypedId::Raw).

fn new_from_raw(raw: u64) -> Self

Constructs Self from a raw primitive. Identical to the concrete new fn.

impl<K> Ord for ObjectId<K>

fn cmp(&self, other: &Self) -> 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<K> PartialEq for ObjectId<K>

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

fn partial_cmp(&self, other: &Self) -> 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<K> TypedId for ObjectId<K>

type Raw = u64

The underlying raw primitive type (u64 or u32).

fn raw_value(&self) -> u64

Returns the underlying raw value.

fn is_zero(&self) -> bool

Returns true when the raw value is the zero sentinel.