Struct backie::QueueConfig

pub struct QueueConfig { /* private fields */ }

Configuration for a queue.

This is used to configure the number of workers, the retention mode, and the pulling interval for a queue.

Examples

Example of configuring a queue with all options:

let config = QueueConfig::new("default")
    .num_workers(5)
    .retention_mode(RetentionMode::KeepAll)
    .pull_interval(Duration::from_secs(1));

Example of queue configuration with default options:

let config = QueueConfig::new("default");
// Also possible to use the `From` trait:
let config: QueueConfig = "default".into();

Implementations

impl QueueConfig

pub fn new(name: impl ToString) -> Self

Create a new queue configuration.

pub fn num_workers(self, num_workers: u32) -> Self

Set the number of workers for this queue.

pub fn retention_mode(self, retention_mode: RetentionMode) -> Self

Set the retention mode for this queue.

pub fn pull_interval(self, pull_interval: Duration) -> Self

Set the pull interval for this queue.

This is the interval at which the queue will be checking for new tasks by calling the backend storage.

Trait Implementations

impl Clone for QueueConfig

fn clone(&self) -> QueueConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueueConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> From<S> for QueueConfigwhere S: ToString,

fn from(name: S) -> Self

Converts to this type from the input type.

impl Hash for QueueConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<QueueConfig> for QueueConfig

fn eq(&self, other: &QueueConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for QueueConfig

impl StructuralEq for QueueConfig

impl StructuralPartialEq for QueueConfig