Skip to main content

Reader

Struct Reader 

Source
pub struct Reader<E: Clock + Storage + Metrics, V: CodecShared> { /* private fields */ }
Expand description

Reader handle for dequeuing and acknowledging items.

There should only be one reader per shared queue.

Implementations§

Source§

impl<E: Clock + Storage + Metrics, V: CodecShared> Reader<E, V>

Source

pub async fn recv(&mut self) -> Result<Option<(u64, V)>, Error>

Receive the next unacknowledged item, waiting if necessary.

This method is designed for use with select!. It will:

  1. Return immediately if an unacked item is available
  2. Wait for the writer to enqueue new items if the queue is empty
  3. Return None if the writer is dropped (no more items will arrive)
§Errors

Returns an error if the underlying storage operation fails.

Source

pub async fn try_recv(&mut self) -> Result<Option<(u64, V)>, Error>

Try to dequeue the next unacknowledged item without waiting.

Returns None immediately if no unacked item is available.

§Errors

Returns an error if the underlying storage operation fails.

Source

pub async fn ack(&self, position: u64) -> Result<(), Error>

See Queue::ack.

§Errors

Returns super::Error::PositionOutOfRange if the position is invalid.

Source

pub async fn ack_up_to(&self, up_to: u64) -> Result<(), Error>

See Queue::ack_up_to.

§Errors

Returns super::Error::PositionOutOfRange if up_to is invalid.

Source

pub async fn ack_floor(&self) -> u64

Source

pub async fn read_position(&self) -> u64

Source

pub async fn is_empty(&self) -> bool

Source

pub async fn reset(&self)

Auto Trait Implementations§

§

impl<E, V> Freeze for Reader<E, V>

§

impl<E, V> !RefUnwindSafe for Reader<E, V>

§

impl<E, V> Send for Reader<E, V>

§

impl<E, V> Sync for Reader<E, V>

§

impl<E, V> Unpin for Reader<E, V>

§

impl<E, V> UnsafeUnpin for Reader<E, V>

§

impl<E, V> !UnwindSafe for Reader<E, V>

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

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,