Struct RunOptions 

#[non_exhaustive]
pub struct RunOptions {
    pub provider: Option<String>,
    pub params: BTreeMap<String, String>,
    pub secrets: Secrets,
    pub host_label: Option<String>,
    pub occupied: Occupied,
    pub ssh_jump: Option<String>,
    pub lifetime: Option<Duration>,
}

The options of one operation.

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.

provider: Option<String>

A Vagrant provider among the manifest’s (${run.provider}).

params: BTreeMap<String, String>

Non-secret values, by param name.

secrets: Secrets

Secret and input values, by slot name. Never stored: pass them again to an operation that creates something.

host_label: Option<String>

What the embedder calls the place the run is on (a server or account id): recorded, so a later operation asked for elsewhere is refused (running_elsewhere).

occupied: Occupied

What up does when the run exists.

ssh_jump: Option<String>

A login (user@host) every SSH of the run goes through first: a Proxmox node whose run bridge this host can’t route to. Recorded at up, so later operations go the same way.

lifetime: Option<Duration>

How long the run may live, for a manifest with an expiry (its default otherwise).

Implementations

impl RunOptions

pub fn new() -> RunOptions

No param, no secret, nothing recorded about the place; a parked run is resumed.

pub fn with_param( self, name: impl Into<String>, value: impl Into<String>, ) -> RunOptions

Sets param name to value.

pub fn with_params( self, params: impl IntoIterator<Item = (String, String)>, ) -> RunOptions

Sets every param of params.

pub fn with_secrets(self, secrets: Secrets) -> RunOptions

Gives the secret and input slots secrets.

pub fn with_host_label(self, label: impl Into<String>) -> RunOptions

Records the place the run is on as label.

pub fn with_provider(self, provider: impl Into<String>) -> RunOptions

Runs with Vagrant provider provider.

pub fn with_ssh_jump(self, login: impl Into<String>) -> RunOptions

Goes through login (user@host) for every SSH of the run.

pub fn with_lifetime(self, lifetime: Duration) -> RunOptions

Lets the run live lifetime (a manifest with an expiry).

pub fn with_occupied(self, occupied: Occupied) -> RunOptions

What up does when the run exists.

Trait Implementations

impl Clone for RunOptions

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 RunOptions

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

Formats the value using the given formatter.

impl Default for RunOptions

fn default() -> Self

Returns the “default value” for a type.