Skip to main content

RequestTable

Struct RequestTable 

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

Tracks in-flight requests for a single connection.

Each accepted connection (UDS or WebSocket) has its own RequestTable. Request IDs are scoped to the connection: the same ID on two different connections refers to two independent requests.

§Examples

use nerve_ipc_core::RequestTable;
use nerve_protocol::types::RequestId;

let mut table = RequestTable::new();
let id = RequestId(42);

// 1. Register when the request begins.
assert!(table.insert(id));

// 2. Check before producing results.
assert!(!table.is_cancelled(id));

// 3. Mark cancelled when a Cancel message arrives.
table.cancel(id);
assert!(table.is_cancelled(id));
assert!(!table.is_active(id));

// 4. Remove on completion.
table.remove(id);
assert!(table.is_empty());

Implementations§

Source§

impl RequestTable

Source

pub fn new() -> Self

Create a new empty request table.

Source

pub fn insert(&mut self, request_id: RequestId) -> bool

Register a new request as RequestState::Active.

Returns false if request_id is already present; the existing entry is left unchanged in that case.

Source

pub fn cancel(&mut self, request_id: RequestId) -> bool

Mark an existing request as RequestState::Cancelled.

Returns false if request_id is not present in the table.

Source

pub fn is_cancelled(&self, request_id: RequestId) -> bool

Returns true if the request has been cancelled.

Source

pub fn remove(&mut self, request_id: RequestId)

Remove the request from the table, regardless of its state.

Source

pub fn len(&self) -> usize

Number of requests currently tracked (active and cancelled combined).

Source

pub fn is_empty(&self) -> bool

Returns true if no requests are currently tracked.

Source

pub fn contains(&self, request_id: RequestId) -> bool

Returns true if request_id is present in the table, regardless of its state.

Source

pub fn is_active(&self, request_id: RequestId) -> bool

Returns true if the request is present and in the RequestState::Active state.

Trait Implementations§

Source§

impl Default for RequestTable

Source§

fn default() -> RequestTable

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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