Struct StreamAnchorHandle 

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

Compact wire handle encoding a WorkerId (upper 64 bits) and a local anchor ID (lower 64 bits) into a single u128.

Serializes via rmp-serde as a two-field struct {hi: u64, lo: u64} — not as raw binary bytes — to guarantee correct round-tripping across msgpack boundaries.

The high bit of the local_id slot ([MPSC_STREAM_BIT]) is reserved as a kind discriminator: 0 → SPSC anchor, 1 → MPSC anchor. Use StreamAnchorHandle::pack for SPSC handles and StreamAnchorHandle::pack_mpsc for MPSC handles; StreamAnchorHandle::is_spsc_stream / StreamAnchorHandle::is_mpsc_stream let the attach entry points fail fast on the wrong kind without wasting an AM round-trip.

local_id of 0 is reserved; crate::streaming::anchor::AnchorManager assigns IDs starting at 1.

Implementations

impl StreamAnchorHandle

pub fn pack(worker_id: WorkerId, local_id: u64) -> Self

Encode a WorkerId and local SPSC anchor ID into a StreamAnchorHandle.

local_id of 0 is reserved. Callers should start local IDs at 1.

Panics (debug only)

Debug-asserts that the high bit of local_id is clear. [MPSC_STREAM_BIT] is reserved for MPSC handles; use pack_mpsc if you need an MPSC anchor handle.

pub fn pack_mpsc(worker_id: WorkerId, local_id: u64) -> Self

Encode a WorkerId and local MPSC anchor ID into a StreamAnchorHandle, setting the [MPSC_STREAM_BIT] discriminator.

local_id is the raw 63-bit counter value; this function ORs in the kind bit. See pack for SPSC.

Panics (debug only)

Debug-asserts that the high bit of local_id is clear so callers do not double-apply the mask.

pub fn unpack(&self) -> (WorkerId, u64)

Decode the WorkerId and local anchor ID from this handle.

The returned local_id retains the [MPSC_STREAM_BIT] if set — it is the value used as the key in the respective anchor registry (SPSC/MPSC registries live in disjoint key ranges thanks to the bit).

pub fn as_u128(&self) -> u128

Return the raw u128 value (useful for logging and display).

pub fn from_u128(raw: u128) -> Self

Reconstruct a handle from a raw u128 — the inverse of as_u128. Does not assert anything about the kind bit: use this when re-hydrating a handle received over the wire as opaque bytes. The kind is recovered via kind etc.

pub fn kind(&self) -> AnchorKind

Return the AnchorKind encoded in the handle.

pub fn is_mpsc_stream(&self) -> bool

true iff this handle refers to an MPSC anchor (the [MPSC_STREAM_BIT] is set in the local_id).

pub fn is_spsc_stream(&self) -> bool

true iff this handle refers to an SPSC anchor.

Trait Implementations

impl Clone for StreamAnchorHandle

fn clone(&self) -> StreamAnchorHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamAnchorHandle

impl Debug for StreamAnchorHandle

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamAnchorHandle

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

Deserialize this value from the given Serde deserializer.

impl Display for StreamAnchorHandle

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

Formats the value using the given formatter.

impl Eq for StreamAnchorHandle

impl Hash for StreamAnchorHandle

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 PartialEq for StreamAnchorHandle

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StreamAnchorHandle

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamAnchorHandle