Struct FormationLaunchOptions 

pub struct FormationLaunchOptions {
    pub formation_id: FormationId,
    pub project_dir: PathBuf,
    pub task: Option<String>,
    pub json: bool,
    pub verbose: bool,
    pub no_env_file: bool,
    pub containment: Option<String>,
    pub unconfined: bool,
    pub ready_timeout: Duration,
    pub stop_grace: Duration,
    pub deadline: Option<SessionDeadline>,
    /* private fields */
}

What a formation launch is given besides its roster.

Fields

formation_id: FormationId

The id every member is launched with, minted once for this launch.

project_dir: PathBuf

The roster’s project directory: the entry member’s --workdir, and every peer’s --store-root, so every member resolves from the stores admission read.

task: Option<String>

--task, passed to the entry member only.

json: bool

--json, passed to the entry member only; peers always run with it.

verbose: bool

--verbose, passed to the entry member only.

no_env_file: bool

--no-env-file, passed to every member.

containment: Option<String>

--containment <class>, passed to every member.

unconfined: bool

The roster’s own stance resolved unconfined (--unconfined, or containment: unconfined in the global config with no --containment): every member is passed --unconfined and resolves it against its own manifest. false passes every member child_launch::CONTAINED_LAUNCH_FLAG instead.

ready_timeout: Duration

Each member’s deadline to become ready, from its spawn. MEMBER_READY_TIMEOUT in production.

stop_grace: Duration

How long a stopped member has after its lifeline is closed. MEMBER_STOP_GRACE in production.

deadline: Option<SessionDeadline>

--deadline: the formation’s one deadline, counted from the launcher’s start and passed to every member as crate::session_status::INHERITED_DEADLINE_FLAG and its moment. It also bounds every peer’s wait to become ready. None bounds nothing.

Implementations

impl FormationLaunchOptions

pub fn new(formation_id: FormationId, project_dir: PathBuf) -> Self

Options with the production deadline and grace, and nothing passed through.

Trait Implementations

impl Clone for FormationLaunchOptions

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 FormationLaunchOptions

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

Formats the value using the given formatter.