Struct swym::tx::Error

pub struct Error { /* fields omitted */ }

Error type indicating that the transaction has failed.

It is typical to route this error back to ThreadKey::rw or ThreadKey::read where the transaction will be retried, however, this is not required.

Notes

Any additional operations on any TCell that has returned Error will continue to return errors for the remainder of the transaction.

Methods

impl Error

pub const RETRY: Self

Error value requesting a retry of the current transaction.

Notes

Returning RETRY to ThreadKey::read or ThreadKey::rw will immediately restart the transaction. This can cause the thread to spin, hurting the performance of other threads. In the future, the behavior of RETRY may change.

Examples

use swym::{tcell::TCell, thread_key, tx::Error};

let thread_key = thread_key::get();
let locked = TCell::new(false);

thread_key.rw(|tx| {
    if locked.get(tx, Default::default())? {
        Err(Error::RETRY)
    } else {
        Ok(locked.set(tx, true)?)
    }
})

Trait Implementations

impl Eq for Error

impl PartialEq<Error> for Error

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T> From<SetError<T>> for Error

fn from(_: SetError<T>) -> Self

Performs the conversion.

impl Debug for Error

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.