Skip to main content

Ring

Struct Ring 

Source
pub struct Ring<F: BackendFactory> { /* private fields */ }
Expand description

Submission and completion router.

Implementations§

Source§

impl<F: BackendFactory> Ring<F>

Source

pub fn new(config: RingConfig) -> Result<Self>

Creates a ring using the selected backend policy.

Source

pub fn backend_kind(&self) -> BackendKind

Returns the active backend kind.

Source

pub fn queue_depth(&self) -> u32

Returns the configured queue depth.

Source

pub fn batch<I, O>(&self, ops: I) -> Result<Vec<O::Output>>
where I: IntoIterator<Item = O>, O: Op,

Submits a batch of operations and returns ordered results.

The ring keeps at most queue_depth requests in flight at once, so callers can batch arbitrarily large iterators without manually chunking.

Source

pub fn chain<T>( &self, run: impl FnOnce(ChainContext<'_, F>) -> Result<T>, ) -> Result<T>

Runs a dependent chain of operations in one call.

This is the high-level API for flows where later operations require outputs from earlier ones, such as connect -> send -> recv.

Source

pub fn submit<O: Op>(&self, op: O) -> Result<Request<O::Output>>

Submits an operation and returns a typed request handle.

Source

pub fn complete(&self, timeout: Option<Duration>) -> Result<CompletionEvent>

Blocks until one completion is routed.

Source

pub fn cancel(&self, id: u64) -> Result<()>

Attempts to cancel a submitted operation.

Source

pub fn in_flight(&self) -> Result<usize>

Returns the number of tracked in-flight operations.

Trait Implementations§

Source§

impl<F: Clone + BackendFactory> Clone for Ring<F>

Source§

fn clone(&self) -> Ring<F>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: BackendFactory> Drop for Ring<F>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<F> !RefUnwindSafe for Ring<F>

§

impl<F> !UnwindSafe for Ring<F>

§

impl<F> Freeze for Ring<F>

§

impl<F> Send for Ring<F>

§

impl<F> Sync for Ring<F>

§

impl<F> Unpin for Ring<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for Ring<F>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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