Struct swym_htm::HardwareTx

pub struct HardwareTx { /* fields omitted */ }

A hardware memory transaction.

On drop, the transaction is committed.

Methods

impl HardwareTx

pub unsafe fn new<F, E>(retry_handler: F) -> Result<Self, E> where
    F: FnMut(BeginCode) -> Result<(), E>, 

Starts a new hardware transaction.

Takes a retry handler which is called on transaction abort. If the retry handler returns Ok(()), the transaction is retried. Any Err is passed back to the location where new was called.

The retry handler is never called with BeginCodes where code.is_started() == true.

Safety

It is unsafe to pass in a retry handler that never returns Err. It is also unsafe to leak the transaction, unless end is manually called sometime after.

pub fn abort(&self) -> !

Aborts the current transaction.

Aborting a hardware transaction will effectively reset the thread/call stack to the location where new was called, passing control to the retry handler.

Even though this never returns, it does not panic.

Trait Implementations

impl Drop for HardwareTx

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for HardwareTx

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

Formats the value using the given formatter.