Skip to main content

CommandRequest

Struct CommandRequest 

Source
pub struct CommandRequest { /* private fields */ }
Expand description

A complete portable request to execute one command.

This type describes execution intent only. It does not contain a sandbox policy because policy is a separate Cageforge concern and will be composed by the backend API. It also does not expose PTY handles, inherited file descriptors, process ids, or OS-specific user/token settings.

Implementations§

Source§

impl CommandRequest

Source

pub fn new(command: CommandSpec) -> Self

Creates a request with the captured-stdio and inherited-environment defaults.

Source

pub fn with_working_directory( self, path: impl Into<PathBuf>, ) -> Result<Self, CommandError>

Sets the working directory.

The path is kept in the caller’s native representation. Relative paths are resolved by the backend, but lexical parent traversal is rejected here so a request cannot escape its later execution context by using parent components.

Source

pub fn without_working_directory(self) -> Self

Removes an explicitly configured working directory.

Source

pub fn with_environment(self, environment: EnvironmentSpec) -> Self

Replaces the environment construction rules.

Source

pub fn with_stdio(self, stdio: StdioSpec) -> Self

Replaces standard stream routing.

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Sets an explicit maximum execution duration.

Source

pub fn with_timeout_policy(self, timeout: TimeoutPolicy) -> Self

Replaces the timeout intent with an explicit policy.

Source

pub fn use_backend_timeout(self) -> Self

Uses the timeout selected by the backend or resolved profile.

Source

pub fn disable_timeout(self) -> Self

Disables the automatic timeout while leaving cancellation available to the execution lifecycle.

Source

pub fn command(&self) -> &CommandSpec

Returns the command line.

Source

pub fn working_directory(&self) -> Option<&Path>

Returns the optional working directory.

Source

pub fn environment(&self) -> &EnvironmentSpec

Returns environment construction rules.

Source

pub fn stdio(&self) -> StdioSpec

Returns standard stream routing.

Source

pub fn timeout_policy(&self) -> TimeoutPolicy

Returns the timeout intent.

Trait Implementations§

Source§

impl Clone for CommandRequest

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 CommandRequest

Source§

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

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

impl Eq for CommandRequest

Source§

impl PartialEq for CommandRequest

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CommandRequest

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> 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.