Skip to main content

CursorAffinity

Struct CursorAffinity 

Source
pub struct CursorAffinity { /* private fields */ }
Expand description

A bounded, TTL’d map from cursor id to the cluster that created it (docs/03 §6). Cloneable handles are not provided; wrap in an Arc to share.

Implementations§

Source§

impl CursorAffinity

Source

pub fn new(ttl: Duration, capacity: usize) -> Self

Builds a cursor-affinity map with the given binding TTL and capacity, reading time from the system clock.

Source

pub fn with_clock(self, clock: Arc<dyn Clock>) -> Self

Swaps the clock that drives expiry (tests inject a ManualClock).

Source

pub fn pin(&self, cursor_id: impl Into<String>, cluster: ClusterId)

Records that cursor_id lives on cluster. Expired bindings are swept first; if the map is still at capacity, the oldest binding is evicted so the new one fits (bounded memory).

Source

pub fn resolve(&self, cursor_id: &str) -> Option<ClusterId>

The cluster cursor_id is pinned to, or None if it is unknown or its binding has expired (lazy expiry, a stale binding is never returned).

Source

pub fn release(&self, cursor_id: &str)

Drops cursor_id’s binding (e.g. on an explicit clear-scroll / close-PIT).

Source

pub fn len(&self) -> usize

The number of bindings currently held (including any not yet swept).

Source

pub fn is_empty(&self) -> bool

Whether no bindings are held.

Trait Implementations§

Source§

impl Debug for CursorAffinity

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.