Struct StartupOptions 

pub struct StartupOptions {
    pub env_file: Option<String>,
    pub enable_http: bool,
    pub enable_jobs: bool,
    pub enable_consumers: bool,
    pub service_protocol: String,
    pub service_weight: i32,
    pub auth_type: String,
    pub worker_max_execute_time_minutes: u64,
    pub event_loop_max_execute_time_minutes: u64,
    pub blocked_thread_check_interval_millis: u64,
    pub worker_pool_size: usize,
    pub event_loop_pool_size: usize,
}

Startup flags and tuning knobs for GenericStartup.

Build with StartupOptions::default_options (via Default) and the with_* builders. worker_pool_size and event_loop_pool_size are recorded and logged; the Tokio runtime itself is owned by the host binary.

Fields

env_file: Option<String>

Path to the dotenv file loaded at startup. None loads .env by default lookup.

enable_http: bool

Whether HTTP controllers are mounted during GenericStartup::bootstrap. Defaults to true.

enable_jobs: bool

Whether GenericStartup::run_jobs starts registered jobs. Defaults to true.

enable_consumers: bool

Whether queue consumers from ConsumerRegistrar are recorded during bootstrap. Defaults to false.

service_protocol: String

Service scheme sent during gateway registration. Defaults to "http".

service_weight: i32

Service weight sent during gateway registration. Defaults to 1.

auth_type: String

Auth type sent during gateway registration. Defaults to "token".

worker_max_execute_time_minutes: u64

Maximum expected worker task duration, in minutes. Defaults to 2.

event_loop_max_execute_time_minutes: u64

Maximum expected event-loop task duration, in minutes. Defaults to 1.

blocked_thread_check_interval_millis: u64

Interval for blocked-thread checks, in milliseconds. Defaults to 750.

worker_pool_size: usize

Worker pool size hint, logged at startup and reported with worker counts. Defaults to 20.

event_loop_pool_size: usize

Event-loop pool size hint, logged at startup. Defaults to 16.

Implementations

impl StartupOptions

pub fn default_options() -> Self

Returns the default startup flags (HTTP and jobs on, consumers off).

pub fn with_env_file(self, path: impl Into<String>) -> Self

Sets the dotenv file path used by GenericStartup::init.

pub fn with_http(self, enabled: bool) -> Self

Sets whether HTTP controllers are mounted during bootstrap.

pub fn with_jobs(self, enabled: bool) -> Self

Sets whether GenericStartup::run_jobs starts registered jobs.

pub fn with_consumers(self, enabled: bool) -> Self

Sets whether queue consumers are recorded during bootstrap.

Trait Implementations

impl Clone for StartupOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartupOptions

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

Formats the value using the given formatter.

impl Default for StartupOptions

fn default() -> Self

Returns the “default value” for a type.