Struct celery::Celery

source ·
pub struct Celery {
    pub name: String,
    pub hostname: String,
    pub broker: Box<dyn Broker>,
    pub default_queue: String,
    pub task_options: TaskOptions,
    /* private fields */
}
Expand description

A Celery app is used to produce or consume tasks asynchronously. This is the struct that is created with the app! macro.

Fields§

§name: String

An arbitrary, human-readable name for the app.

§hostname: String

Node name of the app.

§broker: Box<dyn Broker>

The app’s broker.

§default_queue: String

The default queue to send and receive from.

§task_options: TaskOptions

Default task options.

Implementations§

source§

impl Celery

source

pub async fn display_pretty(&self)

Print a pretty ASCII art logo and configuration settings.

This is useful and fun to print from a worker application right after the Celery app is initialized.

source

pub async fn send_task<T: Task>( &self, task_sig: Signature<T> ) -> Result<AsyncResult, CeleryError>

Send a task to a remote worker. Returns an AsyncResult with the task ID of the task if it was successfully sent.

source

pub async fn register_task<T: Task + 'static>(&self) -> Result<(), CeleryError>

Register a task.

source

pub async fn close(&self) -> Result<(), CeleryError>

Close channels and connections.

source

pub async fn consume(self: &Arc<Self>) -> Result<(), CeleryError>

Consume tasks from the default queue.

source

pub async fn consume_from( self: &Arc<Self>, queues: &[&str] ) -> Result<(), CeleryError>

Consume tasks from any number of queues.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Celery

§

impl Send for Celery

§

impl Sync for Celery

§

impl Unpin for Celery

§

impl !UnwindSafe for Celery

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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: 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 Twhere 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<T> for T

§

type Output = T

Should always be Self
source§

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

§

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 Twhere U: TryFrom<T>,

§

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

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

§

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