Struct arc_swap::Guard

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

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<T: RefCnt, S: Strategy<T>> Guard<T, S>

pub fn into_inner(lease: Self) -> T

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

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>

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

Converts the value into a raw pointer.

impl<T: RefCnt> AsRaw<<T as RefCnt>::Base> for Guard<T>

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

Converts the value into a raw pointer.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<T: RefCnt, S: Strategy<T>> Deref for Guard<T, S>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Formats the value using the given formatter.

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

fn from(inner: T) -> Self

Converts to this type from the input type.