Struct Shared

pub struct Shared<T: ?Sized>(/* private fields */);

A wrapper around a resource possibly shared with SharedReadLocks and WeakReadLocks, but no other Shareds.

Implementations

impl<T> Shared<T>

pub fn new(data: T) -> Self

Create a new Shared.

pub fn unwrap(this: Self) -> Result<T, Self>

Returns the inner value, if the Shared has no associated SharedReadLocks.

Otherwise, an Err is returned with the same Shared that was passed in.

This will succeed even if there are outstanding weak references.

Panics

This function will panic if the lock around the inner value is poisoned.

impl<T: ?Sized> Shared<T>

pub fn get(this: &Self) -> &T

Get a reference to the inner value.

Usually, you don’t need to call this function since Shared<T> implements Deref. Use this if you want to pass the inner value to a generic function where the compiler can’t infer that you want to have the Shared dereferenced otherwise.

Panics

This function will panic if the lock around the inner value is poisoned.

pub fn try_get(this: &Self) -> LockResult<&T>

Try to get a reference to the inner value, returning an error if the lock around it is poisoned.

pub fn lock(this: &mut Self) -> SharedWriteGuard<'_, T>

Lock this Shared to be able to mutate it, blocking the current thread until the operation succeeds.

pub fn get_read_lock(this: &Self) -> SharedReadLock<T>

Get a SharedReadLock for accessing the same resource read-only from elsewhere.

pub fn try_from_inner(rwlock: Arc<RwLock<T>>) -> Result<Self, Arc<RwLock<T>>>

Attempt to create a Shared from its internal representation, Arc<RwLock<T>>.

This returns Ok(_) only if there are no further references (including weak references) to the inner RwLock since otherwise, Shareds invariant of being the only instance that can mutate the inner value would be broken.

pub fn into_inner(this: Self) -> Arc<RwLock<T>>

Turns this Shared into its internal representation, Arc<RwLock<T>>.

pub fn read_count(this: &Self) -> usize

Gets the number of associated SharedReadLocks.

pub fn weak_count(this: &Self) -> usize

Gets the number of associated WeakReadLocks.

Trait Implementations

impl<T: Debug + ?Sized> Debug for Shared<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Shared<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized> Deref for Shared<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.