Struct ProcessEnv 

pub struct ProcessEnv { /* private fields */ }

A struct that can be easily shared, stored in Lua app data, and that also guarantees the pairs are valid OS strings that can be used for process environment variables.

Usable directly from Lua, implementing both FromLua and LuaUserData.

Also provides convenience methods for working with the variables as either OsString or Vec<u8>, where using the latter implicitly converts to an OsString and fails if the conversion is not possible.

Implementations

impl ProcessEnv

pub fn empty() -> Self

pub fn current() -> Self

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get_all(&self) -> Vec<(OsString, OsString)>

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

pub fn set_value(&self, key: impl Into<OsString>, val: impl Into<OsString>)

pub fn remove_value(&self, key: impl AsRef<OsStr>)

pub fn get_all_bytes(&self) -> Vec<(Vec<u8>, Vec<u8>)>

pub fn get_value_bytes(&self, key: impl AsRef<[u8]>) -> Option<Vec<u8>>

pub fn set_value_bytes(&self, key: impl AsRef<[u8]>, val: impl Into<Vec<u8>>)

pub fn remove_value_bytes(&self, key: impl AsRef<[u8]>)

Trait Implementations

impl Clone for ProcessEnv

fn clone(&self) -> ProcessEnv

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessEnv

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

Formats the value using the given formatter.

impl<K: Into<OsString>, V: Into<OsString>> Extend<(K, V)> for ProcessEnv

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K: Into<OsString>, V: Into<OsString>> FromIterator<(K, V)> for ProcessEnv

fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromLua for ProcessEnv

fn from_lua(value: LuaValue, _: &Lua) -> LuaResult<Self>

Performs the conversion.

impl IntoIterator for ProcessEnv

type Item = (OsString, OsString)

The type of the elements being iterated over.

type IntoIter = IntoIter<OsString, OsString>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl UserData for ProcessEnv

fn add_methods<M: LuaUserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn add_fields<F>(fields: &mut F)

where F: UserDataFields<Self>,

Adds custom fields specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.