Skip to main content

PersistentEngine

Struct PersistentEngine 

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

Persistent-engine handle. Owns the host-side view of the ring buffer. The GPU kernel is a separate concern gated behind the persistent cargo feature.

Implementations§

Source§

impl PersistentEngine

Source

pub fn new(ring_size: u32) -> Self

Construct an engine with a ring capacity of ring_size slots. Must be a nonzero power of two so index = slot & (cap-1) is correct.

Source

pub fn try_new(ring_size: u32) -> Result<Self, String>

Construct an engine only when the ring capacity already satisfies the persistent-ring indexing contract.

Source

pub fn ring_size(&self) -> u32

Capacity of the ring buffer.

Source

pub fn enqueue(&self, item: PersistentWorkItem) -> Result<u32, QueueFull>

Enqueue a PersistentWorkItem. Returns Ok(slot_index) on success, or Err(QueueFull) if the ring is full. Thread-safe under concurrent producers (lock-free CAS on head).

Source

pub fn claim(&self) -> Option<PersistentWorkItem>

Consumer-side claim. Returns the next available item or None if the queue is empty. Thread-safe under concurrent consumers.

Source

pub fn mark_done(&self, slot_idx: u32) -> Result<(), String>

Mark item at slot_idx as done.

Source

pub fn is_done(&self, slot_idx: u32) -> Result<bool, String>

Whether the consumer finished the item at slot_idx.

Source

pub fn try_in_flight(&self) -> Result<u32, String>

Number of items queued and pending claim.

Source

pub fn in_flight(&self) -> u32

Number of items queued and pending claim.

Source

pub fn head_counter(&self) -> u64

Monotonic head counter (modulo ring_size = slot index).

Source

pub fn head(&self) -> u32

Monotonic head counter exposed through the legacy u32 API.

Source

pub fn tail_counter(&self) -> u64

Monotonic tail counter.

Source

pub fn tail(&self) -> u32

Monotonic tail counter exposed through the legacy u32 API.

Trait Implementations§

Source§

impl Debug for PersistentEngine

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more