Skip to main content

SessionGuard

Struct SessionGuard 

Source
pub struct SessionGuard<'a, V> { /* private fields */ }
Expand description

A reference to a session variable of type V, returned by SessionExt::get and SessionExt::get_opt.

It borrows the session’s current snapshot through an arc_swap::Guard, so reads never take a lock or a full Arc clone. The guard is tied to the session borrow it was read from, so it is meant to be used on the stack rather than stored in a long-lived data structure (holding it pins an internal arc-swap slot, which can contend with concurrent writers). SessionGuard derefs to V, so it can be used wherever a &V is expected.

Trait Implementations§

Source§

impl<V: VortexSessionVar> Debug for SessionGuard<'_, V>

Source§

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

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

impl<V: VortexSessionVar> Deref for SessionGuard<'_, V>

Source§

type Target = V

The resulting type after dereferencing.
Source§

fn deref(&self) -> &V

Dereferences the value.

Auto Trait Implementations§

§

impl<'a, V> !RefUnwindSafe for SessionGuard<'a, V>

§

impl<'a, V> !UnwindSafe for SessionGuard<'a, V>

§

impl<'a, V> Freeze for SessionGuard<'a, V>

§

impl<'a, V> Send for SessionGuard<'a, V>

§

impl<'a, V> Sync for SessionGuard<'a, V>

§

impl<'a, V> Unpin for SessionGuard<'a, V>

§

impl<'a, V> UnsafeUnpin for SessionGuard<'a, V>

Blanket Implementations§

Source§

impl<T, A, P> Access<T> for P
where A: Access<T> + ?Sized, P: Deref<Target = A>,

Source§

type Guard = <A as Access<T>>::Guard

A guard object containing the value and keeping it alive. Read more
Source§

fn load(&self) -> <P as Access<T>>::Guard

The loading method. Read more
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, A> DynAccess<T> for A
where A: Access<T>, <A as Access<T>>::Guard: 'static,

Source§

fn load(&self) -> DynGuard<T>

The equivalent of Access::load.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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.