Skip to main content

EnvGuard

Struct EnvGuard 

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

Holds the process’s environment lock and restores every variable it touched when dropped — including back to absent.

Implementations§

Source§

impl EnvGuard

Source

pub fn hold() -> Self

Take the lock without changing anything — for a test that only needs to be alone with the environment, or that will set_var later.

Source

pub fn set<K, V>(vars: impl IntoIterator<Item = (K, V)>) -> Self
where K: AsRef<OsStr>, V: AsRef<OsStr>,

Take the lock and set these variables.

Source

pub fn unset<K: AsRef<OsStr>>(vars: impl IntoIterator<Item = K>) -> Self

Take the lock and remove these variables.

Source

pub fn set_var<K: AsRef<OsStr>, V: AsRef<OsStr>>( &mut self, key: K, value: V, ) -> &mut Self

Set one variable inside this guard’s critical section.

Source

pub fn unset_var<K: AsRef<OsStr>>(&mut self, key: K) -> &mut Self

Remove one variable inside this guard’s critical section.

Source

pub fn track_var<K: AsRef<OsStr>>(&mut self, key: K) -> &mut Self

Restore this variable when the guard drops, without changing it now.

For a variable the test does not set but the code under test does. Some production paths use the environment as a hidden parameter and do not put it back — deep_research::provision sets MUR_HOME for the helpers it calls and says so in its own # Concurrency note. A test calling that leaks the value to every later test in the process, and no lock can help: the leak is not a race. Run the suite with --test-threads=1 and it still happens, which is how this was found.

Trait Implementations§

Source§

impl Drop for EnvGuard

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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