BaseQueue

Struct BaseQueue 

Source
pub struct BaseQueue {
    pub name: String,
    pub prefix: String,
    pub task_config: TaskConfig,
    pub queue: Arc<Queue>,
    pub worker: Option<Worker>,
}
Expand description

队列基类

封装 QueueWorker,提供更贴近 TS BaseCoolQueue 的使用体验。

Fields§

§name: String

队列名称

§prefix: String

队列前缀

§task_config: TaskConfig

任务配置

§queue: Arc<Queue>

底层队列

§worker: Option<Worker>

可选 Worker

Implementations§

Source§

impl BaseQueue

Source

pub async fn new(name: &str, config: TaskConfig) -> JobResult<Self>

创建新的队列基类实例,并根据配置自动创建 Queue/Worker

Source

pub async fn producer_only(name: &str, config: TaskConfig) -> JobResult<Self>

只创建生产者(无 Worker)

Source

pub async fn start_worker(&self)

启动 Worker(如果存在)

Source

pub fn stop_worker(&self)

停止 Worker(如果存在)

Source

pub async fn add( &self, name: &str, data: Value, options: JobOptions, ) -> JobResult<Job>

发送单个任务

Source

pub async fn add_bulk( &self, jobs: Vec<(String, Value, JobOptions)>, ) -> JobResult<Vec<Job>>

批量发送任务

Source

pub async fn pause(&self) -> JobResult<()>

暂停队列

Source

pub async fn resume(&self) -> JobResult<()>

恢复队列

Source

pub async fn is_paused(&self) -> JobResult<bool>

队列是否暂停

Source

pub async fn count(&self, status: JobStatus) -> JobResult<u64>

获取各状态任务数量

Source

pub async fn obliterate(&self) -> JobResult<()>

清空队列(包括任务数据)

Auto Trait Implementations§

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.

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
§

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.
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