Struct ICoWCopy 

pub struct ICoWCopy<'copy, ITEM: Debug + Send> { /* private fields */ }

A write-guard which holds new value to which the new values are written. And previous value too. This type of guard is not exclusive, so it does not prevent multiple CoW operations. Normally, if some object which may be written simultaniously i.e lost connection to remote server and reconnect is required, the exclusive lock would be more desirable.

Implementations

impl<'copy, ITEM: Debug + Send> ICoWCopy<'copy, ITEM>

pub fn prev_val(&self) -> &ITEM

Returns a reference to previous value. To access modified version use Deref or DerefMut.

pub fn commit(self) -> Result<(), (ICoWError, Self)>

Commits the changes made in the guarded variable. A non-blocking function. It will not block the thread completly and returns the ICoWError::WouldBlock if attempt to grab the pointer atomically fails.

Returns

The Result::Err is returned with:

• 0 - ICoWError with the error type.

• 1 - ICoWCopy instance itself.

Error types ICoWError:

• ICoWError::ExclusiveLockPending - if exclusivly locked from another thread.

• ICoWError::WouldBlock - is returned if try_write returns TryLockError::WouldBlock and the lock is not exclusive.

pub fn commit_blocking(self) -> Result<(), Self>

Commits the changes to the mainstream instance of ICoW. A partially non-blocking function. It would wait for an exclusive access ignoring the ICoWError::WouldBlock only if the instance is not locked exclusivly.

If Result::Err is returned, the instance is locked exclusivly.

Returns

The Result::Err is returned with:

ICoWCopy commited instance itself.

pub fn into_inner(self) -> ITEM

Drops the instance without commiting changes returning a copy, clone, default, or new i.e what was in the new field of the instance.

Trait Implementations

impl<'copy, ITEM: Debug + Debug + Send> Debug for ICoWCopy<'copy, ITEM>

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

Formats the value using the given formatter.

impl<'copy, ITEM: Debug + Send> Deref for ICoWCopy<'copy, ITEM>

type Target = ITEM

The resulting type after dereferencing.

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

Dereferences the value.

impl<'copy, ITEM: Debug + Send> DerefMut for ICoWCopy<'copy, ITEM>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.