Struct RunOptions 

#[non_exhaustive]
pub struct RunOptions {
    pub gears_cfg: Arc<dyn ConfigProvider>,
    pub db: DbOptions,
    pub shutdown: ShutdownOptions,
    pub clients: Vec<ClientRegistration>,
    pub instance_id: Uuid,
    pub oop: Option<OopSpawnOptions>,
    pub shutdown_deadline: Option<Duration>,
    pub internal_token_provider: Option<InternalTokenProvider>,
}

Options for running the ToolKit runner.

#[non_exhaustive]: construct via RunOptions::new + the with_* builders rather than a struct literal, so adding a new optional field does not break every call site (and out-of-crate consumers get a deprecation-free upgrade path). The four arguments to new are the always-required fields; everything else defaults to “off”.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

gears_cfg: Arc<dyn ConfigProvider>

Provider of gear config sections (raw JSON by gear name).

db: DbOptions

DB strategy: none, or DbManager.

shutdown: ShutdownOptions

Shutdown strategy.

clients: Vec<ClientRegistration>

Pre-registered clients to inject into the ClientHub before gear initialization.

This is useful for OoP bootstrap where clients (like DirectoryGrpcClient) are created before calling run() and need to be available in the ClientHub.

instance_id: Uuid

Process-level instance ID.

This is a unique identifier for this process instance, generated once at bootstrap (either in run_oop_with_options for OoP gears or in the main host). It is propagated to all gears via GearCtx::instance_id() and SystemContext::instance_id().

oop: Option<OopSpawnOptions>

OoP gear spawn configuration.

These gears are spawned after the start phase, once grpc-hub is running and the real directory endpoint is known.

shutdown_deadline: Option<Duration>

Maximum time allowed for each gear’s graceful shutdown before hard-stop.

If None, uses DEFAULT_SHUTDOWN_DEADLINE (35 seconds).

See HostRuntime::with_shutdown_deadline for details on the relationship with WithLifecycle::stop_timeout.

internal_token_provider: Option<InternalTokenProvider>

Process-wide platform-plane credential source (the selected InternalCredential), threaded into every [GearCtx] so #[toolkit::provides]-generated clients attach X-ToolKit-Internal-Token on platform-plane (PlatformSecurityContext) methods. None (Profile 1 / in-process, or no credential configured) attaches nothing.

Implementations

impl RunOptions

pub fn new( gears_cfg: Arc<dyn ConfigProvider>, db: DbOptions, shutdown: ShutdownOptions, instance_id: Uuid, ) -> Self

Create RunOptions with the four always-required fields; all optional fields default to “off” (clients empty, no oop, default shutdown deadline, no platform credential). Layer options on with the with_* builders.

pub fn with_clients(self, clients: Vec<ClientRegistration>) -> Self

Pre-register clients to inject into the ClientHub before gear init.

pub fn with_oop(self, oop: Option<OopSpawnOptions>) -> Self

Set the OoP gear spawn configuration.

pub fn with_shutdown_deadline(self, deadline: Option<Duration>) -> Self

Override the per-gear graceful-shutdown deadline.

pub fn with_internal_token_provider( self, provider: Option<InternalTokenProvider>, ) -> Self

Set the process-wide platform-plane credential source (see the field).