Struct triple_buffer::Output

pub struct Output<T: Send> { /* fields omitted */ }

Consumer interface to the triple buffer

The consumer of data can use this struct to access the latest published update from the producer whenever he likes. Readout is nonblocking: a collision between the producer and consumer will result in cache contention, but deadlocks and scheduling-induced slowdowns cannot happen.

Methods

impl<T: Send> Output<T>

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

Access the latest value from the triple buffer

pub fn updated(&self) -> bool

Tell whether a buffer update is incoming from the producer

This method is only intended for diagnostics purposes. Please do not let it inform your decision of reading a value or not, as that would effectively be building a very poor spinlock-based double buffer implementation. If what you truly need is a double buffer, build yourself a proper blocking one instead of wasting CPU time.

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

Get raw access to the output buffer

This advanced interface allows you to modify the contents of the output buffer, which can in some case improve performance by avoiding to create values of type T when this is an expensive process. One possible application, for example, is to post-process values from the producer.

However, by opting into it, you force yourself to take into account subtle implementation details which you could normally ignore.

First, keep in mind that you can lose access to the current output buffer any time read() or raw_update() is called, as it will be replaced by an updated buffer from the producer automatically.

Second, to reduce the potential for the aforementioned usage error, this method does not update the output buffer automatically. You need to call raw_update() in order to fetch buffer updates from the producer.

To use this method, you have to enable the crate's raw feature

pub fn raw_update(&mut self) -> bool

Update the output buffer

Check for incoming updates from the producer, and if so, update our output buffer to the latest data version. This operation will overwrite any changes which you may have commited into the output buffer.

Return a flag telling whether an update was carried out

To use this method, you have to enable the crate's raw feature

Trait Implementations

impl<T: Debug + Send> Debug for Output<T>

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

Formats the value using the given formatter.