Skip to main content

Docket

Struct Docket 

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

Docket distributed task queue.

The main entry point for submitting and managing distributed tasks.

Implementations§

Source§

impl Docket

Source

pub fn new(settings: DocketSettings) -> DocketResult<Self>

Creates a new Docket with the given settings.

Source

pub fn memory() -> Self

Creates a Docket with memory backend (for testing).

Source

pub fn submit( &self, task_type: impl Into<String>, params: Value, ) -> DocketResult<TaskId>

Submits a task to the queue.

Source

pub fn submit_with_options( &self, task_type: impl Into<String>, params: Value, options: SubmitOptions, ) -> DocketResult<TaskId>

Submits a task with custom options.

Source

pub fn get_task(&self, task_id: &TaskId) -> DocketResult<Option<DocketTask>>

Gets a task by ID.

Source

pub fn list_tasks( &self, status: Option<TaskStatus>, limit: usize, ) -> DocketResult<Vec<DocketTask>>

Lists tasks with optional status filter.

Source

pub fn cancel(&self, task_id: &TaskId, reason: Option<&str>) -> DocketResult<()>

Cancels a task.

Source

pub fn stats(&self) -> DocketResult<QueueStats>

Returns queue statistics.

Source

pub fn worker(&self) -> WorkerBuilder

Creates a worker builder.

Source

pub fn settings(&self) -> &DocketSettings

Returns the settings.

Source

pub fn into_shared(self) -> SharedDocket

Converts to a shared handle.

Trait Implementations§

Source§

impl Debug for Docket

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Freeze for Docket

§

impl !RefUnwindSafe for Docket

§

impl Send for Docket

§

impl Sync for Docket

§

impl Unpin for Docket

§

impl !UnwindSafe for Docket

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

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> 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<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