Struct Env

pub struct Env { /* private fields */ }

Generic collection of environment variables.

Examples

use libcnb::Env;
use std::process::Command;

let mut env = Env::new();
env.insert("FOO", "BAR");
env.insert("BAZ", "BLAH");

let output = Command::new("printenv")
    .env_clear()
    .envs(&env)
    .output()
    .unwrap();

assert_eq!(
    "BAZ=BLAH\nFOO=BAR\n",
    String::from_utf8_lossy(&output.stdout)
);

Implementations

impl Env

pub fn from_current() -> Self

Creates a new Env from all the environment variables of the current process.

The returned Env contains a snapshot of the process’s environment variables at the time of this invocation. Modifications to environment variables afterwards will not be reflected in the returned value.

See std::env::vars_os

pub fn new() -> Self

Creates an empty Env struct.

pub fn insert( &mut self, key: impl Into<OsString>, value: impl Into<OsString>, ) -> &mut Self

Inserts a key-value pair into the environment, overriding the value if key was already present.

pub fn get(&self, key: impl AsRef<OsStr>) -> Option<&OsString>

Returns the value corresponding to the given key.

pub fn get_string_lossy(&self, key: impl AsRef<OsStr>) -> Option<String>

Returns the value corresponding to the given key, interpreted as Unicode data.

Any non-Unicode sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

See OsStr::to_string_lossy for more details.

pub fn contains_key(&self, key: impl AsRef<OsStr>) -> bool

Returns true if the environment contains a value for the specified key.

pub fn iter(&self) -> Iter<'_, OsString, OsString>

Trait Implementations

impl Clone for Env

fn clone(&self) -> Env

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Env

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

Formats the value using the given formatter.

impl Default for Env

fn default() -> Env

Returns the “default value” for a type.

impl From<VarsOs> for Env

fn from(vars_os: VarsOs) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a Env

type Item = (&'a OsString, &'a OsString)

The type of the elements being iterated over.

type IntoIter = Iter<'a, OsString, OsString>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Env

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Env

impl StructuralPartialEq for Env