Skip to main content

RcuOptionArc

Struct RcuOptionArc 

Source
pub struct RcuOptionArc<T: Send + Sync + 'static> { /* private fields */ }
Expand description

An RCU (Read-Copy-Update) wrapper around Option<Arc<T>>.

The Arc can be dereferenced from multiple threads concurrently without blocking. When the Arc is replaced, reads may continue to see the old Arc pointer for some period of time.

Implementations§

Source§

impl<T: Send + Sync + 'static> RcuOptionArc<T>

Source

pub fn new(data: Option<Arc<T>>) -> Self

Create a new RCU wrapper around an Option<Arc<T>>.

Source

pub fn read(&self) -> Option<RcuReadGuard<T>>

Read the value of the wrapped Arc, if present.

The object referenced by the RCU Arc will remain valid until the RcuReadGuard is dropped. However, another thread running concurrently might see a different value for the object.

Source

pub fn as_ref<'a>(&self, scope: &'a RcuReadScope) -> Option<&'a T>

Returns a reference to the value of the wrapped Arc, if present.

The object referenced by the RCU Arc will remain valid until the RcuReadScope is dropped. However, another thread running concurrently might see a different value for the object.

Source

pub fn update(&self, data: Option<Arc<T>>)

Write a new Option<Arc<T>> to the RCU wrapper.

Concurrent readers may continue to see the old Arc pointer until the RCU state machine has made sufficient progress to ensure that no concurrent readers are holding read guards.

Source

pub fn to_option_arc(&self) -> Option<Arc<T>>

Create a new Arc<T> to the object referenced by the wrapped Arc, if present.

This function returns a new Option<Arc<T>> to the object referenced by the wrapped Arc, potentially increasing the reference count of the object by one.

Trait Implementations§

Source§

impl<T: Send + Sync + 'static> Clone for RcuOptionArc<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Send + Sync + 'static> Debug for RcuOptionArc<T>

Source§

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

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

impl<T: Send + Sync + 'static> Default for RcuOptionArc<T>

Source§

fn default() -> Self

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

impl<T: Send + Sync + 'static> Drop for RcuOptionArc<T>

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
Source§

impl<T: Send + Sync + 'static> From<Option<Arc<T>>> for RcuOptionArc<T>

Source§

fn from(data: Option<Arc<T>>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> !Freeze for RcuOptionArc<T>

§

impl<T> RefUnwindSafe for RcuOptionArc<T>

§

impl<T> Send for RcuOptionArc<T>

§

impl<T> Sync for RcuOptionArc<T>

§

impl<T> Unpin for RcuOptionArc<T>

§

impl<T> UnsafeUnpin for RcuOptionArc<T>

§

impl<T> UnwindSafe for RcuOptionArc<T>
where T: RefUnwindSafe,

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.