Skip to main content

WrapperOptions

Struct WrapperOptions 

Source
pub struct WrapperOptions {
Show 62 fields pub isolated: Option<String>, pub attached: bool, pub detached: bool, pub session: Option<String>, pub session_id: Option<String>, pub image: Option<String>, pub volumes: Vec<String>, pub mounts: Vec<String>, pub env: Vec<String>, pub labels: Vec<String>, pub help: bool, pub no_sanitize: bool, pub remove_original: bool, pub privileged: bool, pub init: Option<bool>, pub network: Option<String>, pub networks: Vec<String>, pub network_aliases: Vec<String>, pub on_kill_resume: Option<u32>, pub recovery_command: Option<String>, pub on_kill_resume_delay: Option<String>, pub cpu_penalty: bool, pub cpu_penalty_config: Option<Config>, pub memory: Option<String>, pub memory_swap: Option<String>, pub memory_reservation: Option<String>, pub cpus: Option<String>, pub on_kill_resume_memory: Option<String>, pub resource_limits: Vec<String>, pub resolved_limits: Value, pub endpoint: Option<String>, pub user: bool, pub user_name: Option<String>, pub keep_user: bool, 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 use_command_stream: bool, pub use_formal_ai: bool, pub status: Option<String>, pub list: bool, pub running: bool, pub upload_log: Option<String>, pub output_format: Option<String>, pub stop: Option<String>, pub terminate: Option<String>, pub attach: Option<String>, pub read_only: bool, pub resume: Option<String>, pub resume_all: bool, pub cleanup: bool, pub cleanup_dry_run: bool, pub cleanup_target: Option<String>, pub alias: Option<String>, pub rename: Option<String>, pub new_name: Option<String>, pub append_attempt: bool, pub continues: Option<String>, pub snapshot: SnapshotResumeOptions,
}
Expand description

Wrapper options parsed from command line

Fields§

§isolated: Option<String>

Isolation backend: screen, tmux, docker, ssh

§attached: bool

Run in attached mode

§detached: bool

Run in detached mode

§session: Option<String>

Session name

§session_id: Option<String>

Session ID (UUID) for tracking - auto-generated if not provided

§image: Option<String>

Docker image

§volumes: Vec<String>

Docker bind mounts/volumes (-v/–volume), applied to docker isolation

§mounts: Vec<String>

Docker –mount specs, applied to docker isolation

§env: Vec<String>

Docker environment variables (-e/–env, KEY=VALUE), applied to docker isolation

§labels: Vec<String>

Caller attribution for Docker containers.

§help: bool§no_sanitize: bool§remove_original: bool§privileged: bool

Run docker container in privileged mode

§init: Option<bool>

docker run --init; None until resolved from START_COMMAND_DOCKER_INIT (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

§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)

§on_kill_resume_delay: Option<String>

Random <min>[-<max>] seconds to wait before each such resume (issue #181)

§cpu_penalty: bool§cpu_penalty_config: Option<Config>§memory: Option<String>§memory_swap: Option<String>§memory_reservation: Option<String>§cpus: Option<String>§on_kill_resume_memory: Option<String>§resource_limits: Vec<String>§resolved_limits: Value§endpoint: Option<String>

SSH endpoint (e.g., user@host)

§user: bool

Create isolated user

§user_name: Option<String>

Optional custom username for isolated user

§keep_user: bool

Keep isolated user after command completes

§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

§use_command_stream: bool

Use command-stream library for command execution

§use_formal_ai: bool

Natural-language request performed through Formal AI (issue #255)

§status: Option<String>

UUID to query status for

§list: bool

List all tracked execution records

§running: bool

With –list, only report executions that are still running

§upload_log: Option<String>

UUID/session name whose stored log should be uploaded

§output_format: Option<String>

Output format for status/list (links-notation, json, text)

§stop: Option<String>

UUID/session name to stop gracefully

§terminate: Option<String>

UUID/session name to terminate immediately

§attach: Option<String>

UUID/session name to attach to

§read_only: bool

With –attach, follow output without forwarding stdin

§resume: Option<String>

UUID/session name to resume

§resume_all: bool

Resume every execution still marked running

§cleanup: bool

Clean up stale “executing” records

§cleanup_dry_run: bool

Show what would be cleaned without actually cleaning

§cleanup_target: Option<String>

UUID/session name whose containers and images –cleanup removes

§alias: Option<String>

Execution --alias adds a name to (issue #231)

§rename: Option<String>

Execution --rename renames (issue #231)

§new_name: Option<String>

Name given by --alias/--rename

§append_attempt: bool

Run as the next attempt of the --session-id execution (issue #229)

§continues: Option<String>

Execution this launch continues (--continues, issue #231)

§snapshot: SnapshotResumeOptions

–snapshot-wait, –remove-original-after, … (issue #224)

Trait Implementations§

Source§

impl Clone for WrapperOptions

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 WrapperOptions

Source§

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

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

impl Default for WrapperOptions

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.