Skip to main content

ShellEnv

Struct ShellEnv 

Source
pub struct ShellEnv {
    pub variables: HashMap<String, ShellVar>,
    pub functions: HashMap<String, FunctionDef>,
    pub aliases: HashMap<String, String>,
    pub exit_status: i32,
    pub pid: u32,
    pub ppid: u32,
    pub positional_params: Vec<String>,
}
Expand description

The full shell environment state.

Fields§

§variables: HashMap<String, ShellVar>

Named variables.

§functions: HashMap<String, FunctionDef>

Shell functions (stored as AST nodes).

§aliases: HashMap<String, String>

Aliases: name -> replacement text.

§exit_status: i32

Exit status of the last command ($?).

§pid: u32

PID of the shell process ($$).

§ppid: u32

Parent PID ($PPID).

§positional_params: Vec<String>

Positional parameters ($1, $2, …).

Implementations§

Source§

impl ShellEnv

Source

pub fn new() -> Self

Create a new environment, inheriting the OS environment variables and capturing the current PID/PPID.

Source

pub fn get_var(&self, name: &str) -> Option<&str>

Get a variable’s value, if it exists.

Source

pub fn set_var(&mut self, name: &str, value: &str)

Set a variable. Fails silently if the variable is read-only.

Source

pub fn export_var(&mut self, name: &str)

Mark a variable as exported.

Source

pub fn unset_var(&mut self, name: &str)

Remove a variable. Fails silently if it is read-only.

Source

pub fn to_env_vec(&self) -> Vec<CString>

Build the envp array for execve(2).

Returns a list of CStrings in KEY=VALUE format for every exported variable.

Source

pub fn to_argv(words: &[impl AsRef<OsStr>]) -> Vec<CString>

Build an argv from an OsStr slice (convenience for fork/exec).

Trait Implementations§

Source§

impl Clone for ShellEnv

Source§

fn clone(&self) -> ShellEnv

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ShellEnv

Source§

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

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

impl Default for ShellEnv

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl ShellEnvironment for ShellEnv

Implements the frost_builtins::ShellEnvironment trait so that built-in commands can interact with the shell state.

Source§

fn get_var(&self, name: &str) -> Option<&str>

Source§

fn set_var(&mut self, name: &str, value: &str)

Source§

fn export_var(&mut self, name: &str)

Source§

fn unset_var(&mut self, name: &str)

Source§

fn exit_status(&self) -> i32

Source§

fn set_exit_status(&mut self, status: i32)

Source§

fn chdir(&mut self, path: &str) -> Result<(), String>

Source§

fn home_dir(&self) -> Option<&str>

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more