Struct arc_swap::Guard[−][src]

pub struct Guard<T: RefCnt, S: Strategy<T> = DefaultStrategy> { /* fields omitted */ }
Expand description

A temporary storage of the pointer.

This guard object is returned from most loading methods (with the notable exception of load_full). It dereferences to the smart pointer loaded, so most operations are to be done using that.

Implementations

impl<'a, T: RefCnt, S: Strategy<T>> Guard<T, S>[src]

pub fn into_inner(lease: Self) -> T[src]

Converts it into the held value.

This, on occasion, may be a tiny bit faster than cloning the Arc or whatever is being held inside.

pub fn from_inner(inner: T) -> Self[src]

Create a guard for a given value inner.

This can be useful on occasion to pass a specific object to code that expects or wants to store a Guard.

Example

// Create two guards pointing to the same object
let g1 = p.load();
let g2 = Guard::<_, DefaultStrategy>::from_inner(Arc::clone(&*g1));

Trait Implementations

impl<'a, T: RefCnt> AsRaw<<T as RefCnt>::Base> for &'a Guard<T>[src]

fn as_raw(&self) -> *mut T::Base[src]

Converts the value into a raw pointer.

impl<'a, T: RefCnt> AsRaw<<T as RefCnt>::Base> for Guard<T>[src]

fn as_raw(&self) -> *mut T::Base[src]

Converts the value into a raw pointer.

impl<T: Debug + RefCnt, S: Strategy<T>> Debug for Guard<T, S>[src]

fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult[src]

Formats the value using the given formatter. Read more

impl<T: Default + RefCnt, S: Strategy<T>> Default for Guard<T, S>[src]

fn default() -> Self[src]

Returns the “default value” for a type. Read more

impl<'a, T: RefCnt, S: Strategy<T>> Deref for Guard<T, S>[src]

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T[src]

Dereferences the value.

impl<T: Display + RefCnt, S: Strategy<T>> Display for Guard<T, S>[src]

fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult[src]

Formats the value using the given formatter. Read more

impl<T: RefCnt, S: Strategy<T>> From<T> for Guard<T, S>[src]

fn from(inner: T) -> Self[src]

Performs the conversion.

Auto Trait Implementations

impl<T, S> RefUnwindSafe for Guard<T, S> where
    <S as InnerStrategy<T>>::Protected: RefUnwindSafe, 

impl<T, S> Send for Guard<T, S> where
    <S as InnerStrategy<T>>::Protected: Send, 

impl<T, S> Sync for Guard<T, S> where
    <S as InnerStrategy<T>>::Protected: Sync, 

impl<T, S> Unpin for Guard<T, S> where
    <S as InnerStrategy<T>>::Protected: Unpin, 

impl<T, S> UnwindSafe for Guard<T, S> where
    <S as InnerStrategy<T>>::Protected: UnwindSafe, 

Blanket Implementations

impl<T, A, P> Access<T> for P where
    A: Access<T>,
    P: Deref<Target = A>, [src]

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

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

pub fn load(&Self) -> <P as Access<T>>::Guard[src]

The loading method. Read more

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T, A> DynAccess<T> for A where
    A: Access<T>,
    <A as Access<T>>::Guard: 'static, [src]

pub fn load(&Self) -> DynGuard<T>[src]

The equivalent of Access::load.

impl<T> From<!> for T[src]

pub fn from(t: !) -> T[src]

Performs the conversion.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToString for T where
    T: Display + ?Sized, [src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.