redis_queue::types

Struct FetchParams

pub struct FetchParams<'a> {
    pub group: &'a str,
    pub consumer: &'a str,
    pub typ: FetchType,
    pub count: usize,
    pub timeout: Option<Duration>,
}

Expand description

Parameters for fetch request.

Fields§

§group: &'a str

Group name.

This is used as identifier of group of pending messages.

When message is successfully read, it is moved inside this group.

At any point user can XACK to confirm message is consumed and delete it.

Otherwise fetch it again (in case of crash or something similar)

§consumer: &'a str

Consumer name

Used to identifier client reading messages If message is successfully read from Queue, then message is moved to pending list, belonging to this consumer.

From now on, this message can be accessed only by this consumer.

§typ: FetchType

Fetch type

§count: usize

Number of messages to fetch maximum.

If 0, fetches all available

§timeout: Option<Duration>

Requests to block for specified duration in milliseconds.

Auto Trait Implementations§

impl<'a> Freeze for FetchParams<'a>

impl<'a> RefUnwindSafe for FetchParams<'a>

impl<'a> Send for FetchParams<'a>

impl<'a> Sync for FetchParams<'a>

impl<'a> Unpin for FetchParams<'a>

impl<'a> UnwindSafe for FetchParams<'a>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,