Skip to main content

IsolationOptions

Struct IsolationOptions 

Source
pub struct IsolationOptions {
Show 31 fields pub session: Option<String>, pub image: Option<String>, pub volumes: Vec<String>, pub mounts: Vec<String>, pub env: Vec<String>, pub labels: Vec<String>, pub uuid: Option<String>, pub root_session: Option<String>, pub resume_count: u32, pub privileged: bool, pub init: bool, pub network: Option<String>, pub networks: Vec<String>, pub network_aliases: Vec<String>, pub resource_limits: Vec<String>, pub cpu_penalty_config: Option<Config>, pub on_kill_resume: Option<u32>, pub recovery_command: Option<String>, pub endpoint: Option<String>, pub detached: bool, pub user: Option<String>, pub keep_alive: bool, pub auto_remove_docker_container: bool, pub always_cleanup_container: bool, pub keep_container: bool, pub keep_container_on_fail: bool, pub shell: String, pub log_path: Option<PathBuf>, pub execution_id: Option<String>, pub defer_completion_watcher: bool, pub attempt_number: u64,
}
Expand description

Options for isolation

Fields§

§session: Option<String>

Session name

§image: Option<String>

Docker image

§volumes: Vec<String>

Docker bind mounts/volumes (-v/–volume)

§mounts: Vec<String>

Docker –mount specs

§env: Vec<String>

Docker environment variables (-e/–env, KEY=VALUE)

§labels: Vec<String>§uuid: Option<String>§root_session: Option<String>§resume_count: u32§privileged: bool

Run docker container in privileged mode

§init: bool

docker run --init: tini as PID 1 reaps orphans (issue #244)

§network: Option<String>

First Docker network name (compatibility accessor)

§networks: Vec<String>

Ordered Docker network names

§network_aliases: Vec<String>

Docker network-scoped aliases

§resource_limits: Vec<String>

Docker resource limits in --flag=value form (issue #176)

§cpu_penalty_config: Option<Config>§on_kill_resume: Option<u32>

Resume up to N times when the docker main process is killed (issue #176)

§recovery_command: Option<String>

Command run in the same container on such a resume (issue #176)

§endpoint: Option<String>

SSH endpoint

§detached: bool

Run in detached mode

§user: Option<String>

User to run command as

§keep_alive: bool

Keep environment alive after command exits

§auto_remove_docker_container: bool

Auto-remove docker container after exit

§always_cleanup_container: bool

Force docker container cleanup after exit

§keep_container: bool

Keep docker container filesystem after exit

§keep_container_on_fail: bool

Keep docker container filesystem when command fails or OOM-kills

§shell: String

Shell to use in isolation environments: auto, bash, zsh, sh

§log_path: Option<PathBuf>

Log path where isolation backends should append live output

§execution_id: Option<String>

UUID of the execution record a detached backend must finalize once the session ends (issue #170.1). None disables store bookkeeping.

§defer_completion_watcher: bool

Explicit resume attaches only after saving its new attempt.

§attempt_number: u64

START_ATTEMPT of the launched command (issue #230); 0 means 1.

Trait Implementations§

Source§

impl Clone for IsolationOptions

Source§

fn clone(&self) -> Self

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 IsolationOptions

Source§

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

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

impl Default for IsolationOptions

Source§

fn default() -> Self

Returns the “default value” for a type. 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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.