Struct ShellVariable

pub struct ShellVariable { /* private fields */ }

A shell variable.

Implementations

impl ShellVariable

pub fn new<I: Into<ShellValue>>(value: I) -> Self

Returns a new shell variable, initialized with the given value.

Arguments

• value - The value to associate with the variable.

pub const fn value(&self) -> &ShellValue

Returns the value associated with the variable.

pub const fn is_exported(&self) -> bool

Returns whether or not the variable is exported to child processes.

pub const fn export(&mut self) -> &mut Self

Marks the variable as exported to child processes.

pub const fn unexport(&mut self) -> &mut Self

Marks the variable as not exported to child processes.

pub const fn is_readonly(&self) -> bool

Returns whether or not the variable is read-only.

pub const fn set_readonly(&mut self) -> &mut Self

Marks the variable as read-only.

pub const fn unset_readonly(&mut self) -> Result<&mut Self, Error>

Marks the variable as not read-only.

pub const fn is_trace_enabled(&self) -> bool

Returns whether or not the variable is traced.

pub const fn enable_trace(&mut self) -> &mut Self

Marks the variable as traced.

pub const fn disable_trace(&mut self) -> &mut Self

Marks the variable as not traced.

pub const fn is_enumerable(&self) -> bool

Returns whether or not the variable should be enumerated in the shell’s environment.

pub const fn hide_from_enumeration(&mut self) -> &mut Self

Marks the variable as not enumerable in the shell’s environment.

pub const fn get_update_transform(&self) -> ShellVariableUpdateTransform

Return the update transform associated with the variable.

pub const fn set_update_transform( &mut self, transform: ShellVariableUpdateTransform, )

Set the update transform associated with the variable.

pub const fn is_treated_as_integer(&self) -> bool

Returns whether or not the variable should be treated as an integer.

pub const fn treat_as_integer(&mut self) -> &mut Self

Marks the variable as being treated as an integer.

pub const fn unset_treat_as_integer(&mut self) -> &mut Self

Marks the variable as not being treated as an integer.

pub const fn is_treated_as_nameref(&self) -> bool

Returns whether or not the variable should be treated as a name reference.

pub const fn treat_as_nameref(&mut self) -> &mut Self

Marks the variable as being treated as a name reference.

pub const fn unset_treat_as_nameref(&mut self) -> &mut Self

Marks the variable as not being treated as a name reference.

pub fn convert_to_indexed_array(&mut self) -> Result<(), Error>

Converts the variable to an indexed array.

pub fn convert_to_associative_array(&mut self) -> Result<(), Error>

Converts the variable to an associative array.

pub fn assign( &mut self, value: ShellValueLiteral, append: bool, ) -> Result<(), Error>

Assign the given value to the variable, conditionally appending to the preexisting value.

Arguments

• value - The value to assign to the variable.
• append - Whether or not to append the value to the preexisting value.

pub fn assign_at_index( &mut self, array_index: String, value: String, append: bool, ) -> Result<(), Error>

Assign the given value to the variable at the given index, conditionally appending to the preexisting value present at that element within the value.

Arguments

• array_index - The index at which to assign the value.
• value - The value to assign to the variable at the given index.
• append - Whether or not to append the value to the preexisting value stored at the given index.

pub fn unset_index(&mut self, index: &str) -> Result<bool, Error>

Tries to unset the value stored at the given index in the variable. Returns whether or not a value was unset.

Arguments

• index - The index at which to unset the value.

pub fn get_attribute_flags(&self, shell: &Shell) -> String

Returns the canonical attribute flag string for this variable.

Trait Implementations

impl Clone for ShellVariable

fn clone(&self) -> ShellVariable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellVariable

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

Formats the value using the given formatter.

impl Default for ShellVariable

fn default() -> Self

Returns the “default value” for a type.