Struct RwBuffer

pub struct RwBuffer(/* private fields */);

A base instance which holds the leaked pointer to RwBufferInner.

This instance can provide either an exclusive write access or multiple read access, but not at the same time. Can be used to store the instance. This instance is Send and Sync because the insternals are guarded by ordered atomic operations.

Implementations

impl RwBuffer

pub fn is_free(&self) -> bool

Checks if this instance satisfies the following conditions:

• No exclusive write access

• No read access

• There is only one base reference.

Returns

• • true if instance satisfies the conditions above.
• • false if does not satisfy the conditions above.

pub fn accure_if_free(&self) -> bool

Accures the instance, if it satisfy the following conditions:

• No exclusive write access

• No read access

• There is only one base reference.

Returns

• • true if instance satisfies the conditions above.
• • false if does not satisfy the conditions above.

pub fn write(&self) -> RwBufferRes<WBuffer>

Attemts to make an exclusive (write) access to the buffer.

Returns

A Result in form of RwBufferRes is returned with:

• Result::Ok with the WBuffer instance

• Result::Err may be returned a RwBufferError::WriteTryAgianLater in case if the there is/are an active read references.

pub fn read(&self) -> RwBufferRes<RBuffer>

Attemts to make a shared (read) access to the buffer.

Returns

A Result in form of RwBufferRes is returned with:

• Result::Ok with the RBuffer instance

• Result::Err with error type is returned:

• RwBufferError::TooManyRead is returned when the soft limit of references was reached.

• RwBufferError::ReadTryAgianLater is returned if there is an active exclusive access.

Trait Implementations

impl Clone for RwBuffer

fn clone(&self) -> Self

Clones the instance and increasing the base ref count.

Will panic if a soft limit of refs were reached.

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

Performs copy-assignment from source.

impl Debug for RwBuffer

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

Formats the value using the given formatter.

impl Drop for RwBuffer

fn drop(&mut self)

Drops the RwBuffer instance. In case if there is no readers and writers, then drop immidiatly the inner data. In case if there is any readers or writing, then drop only wrapper which is the zero reader.

impl PartialEq for RwBuffer

fn eq(&self, other: &RwBuffer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RwBuffer

impl Send for RwBuffer

impl StructuralPartialEq for RwBuffer

impl Sync for RwBuffer