Struct netstack3_sync::RwLock

pub struct RwLock<T>(/* private fields */);

A sync::RwLock assuming lock poisoning will never occur.

Implementations

impl<T> RwLock<T>

pub fn new(t: T) -> RwLock<T>

Creates a new instance of an RwLock<T> which is unlocked.

pub fn read(&self) -> RwLockReadGuard<'_, T>

Locks this rwlock with shared read access, blocking the current thread until it can be acquired.

See sync::RwLock::read for more details.

Panics

This method may panic if the calling thread already holds the read or write lock.

pub fn write(&self) -> RwLockWriteGuard<'_, T>

Locks this rwlock with exclusive write access, blocking the current thread until it can be acquired.

See sync::RwLock::write for more details.

Panics

This method may panic if the calling thread already holds the read or write lock.

pub fn into_inner(self) -> T

Consumes this rwlock, returning the underlying data.

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying data.

Since this call borrows the RwLock mutably, no actual locking needs to take place. See sync::RwLock::get_mut for more details.

Trait Implementations

impl<T: Debug> Debug for RwLock<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for RwLock<T>

fn default() -> RwLock<T>

Returns the “default value” for a type.

impl<T, I: Ip> GenericOverIp<I> for RwLock<T>

where T: GenericOverIp<I>,

type Type = RwLock<<T as GenericOverIp<I>>::Type>

The type of Self when its IP-generic parameter is replaced with the type NewIp.

impl<T: 'static> ReadWriteLock<T> for RwLock<T>

type ReadGuard<'l> = LockGuard<'l, RwLock<T>, RwLockReadGuard<'l, T>>

The guard type returned when locking for reads (i.e. shared).

type WriteGuard<'l> = LockGuard<'l, RwLock<T>, RwLockWriteGuard<'l, T>>

The guard type returned when locking for writes (i.e. exclusive).

fn read_lock(&self) -> Self::ReadGuard<'_>

Locks this lock for reading.

fn write_lock(&self) -> Self::WriteGuard<'_>

Locks this lock for writing.