Skip to main content

TaskConfig

Struct TaskConfig 

Source
pub struct TaskConfig {
    pub task_name: String,
    pub priority: i32,
    pub pool: String,
    pub retry_policy: RetryPolicy,
    pub rate_limit_policy: RateLimitPolicy,
    pub idempotency_mode: Option<IdempotencyMode>,
    pub updated_at: DateTime<Utc>,
}
Expand description

Per-task config persisted for admin UI and enqueue defaults.

Seeded from task macro attributes on first enqueue; admins can later upsert via QueueBackend::upsert_task_config or the axum /tasks/{name}/config route. On enqueue, Boson merges descriptor defaults with any stored config to set Job priority, pool, and policies.

Getting started: define tasks.

§Example — macro attrs become the initial config

use boson::task;

#[task(
    name = "notify",
    priority = 10,
    pool = "alerts",
    max_attempts = 5,
    max_in_flight = 20
)]
async fn notify(ctx: Box<dyn boson::ExecutionContext>, message: String) -> boson_core::Result<()> {
    let _ = (ctx, message);
    Ok(())
}
// First Notify::send_with(...) persists a TaskConfig shaped like those attributes.

Fields§

§task_name: String

Task name (unique key).

§priority: i32

Override priority (lower = higher priority).

§pool: String

Override pool name.

§retry_policy: RetryPolicy

Retry policy override.

§rate_limit_policy: RateLimitPolicy

Enqueue rate limits (optional).

§idempotency_mode: Option<IdempotencyMode>

Per-task idempotency override (None = inherit runtime / builder default).

§updated_at: DateTime<Utc>

When created/updated.

Implementations§

Source§

impl TaskConfig

Source

pub fn default_for(task_name: &str) -> TaskConfig

Create default config for a task name.

§Examples
use boson_core::TaskConfig;

let config = TaskConfig::default_for("notify");
assert_eq!(config.task_name, "notify");
assert_eq!(config.pool, "global");
assert_eq!(config.priority, 1);
Source

pub fn resolved_idempotency_mode( &self, runtime_default: IdempotencyMode, ) -> IdempotencyMode

Resolve effective idempotency mode (task override, else runtime_default).

Source

pub fn from_policy_defaults( task_name: &str, priority: i32, pool: impl Into<String>, retry_policy: RetryPolicy, rate_limit_policy: RateLimitPolicy, idempotency_mode: Option<IdempotencyMode>, ) -> TaskConfig

Build config from explicit policy defaults (typically from a task descriptor).

Source

pub const fn with_runtime_idempotency_fallback( self, runtime_default: IdempotencyMode, ) -> TaskConfig

Fill idempotency_mode from the runtime default when unset.

Trait Implementations§

Source§

impl Clone for TaskConfig

Source§

fn clone(&self) -> TaskConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TaskConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TaskConfig

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<TaskConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TaskConfig

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

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