Struct io_interner::IOInterner

pub struct IOInterner<T: Write + Read + Seek> {
    pub inner: Mutex<T>,
}

A struct wrapping a Mutex<T> used for storing and retrieving data thought readers.

Note that T it's wrapped into a Mutex for ensure IOObj does not lock access to the IOInterner and to guarantee will only lock at Read methods.

Fields

inner: Mutex<T>

The underlying writer wrapped into a Mutex.

The IOEntry comparison algorithm would mess up if you do not ensure that already allocated data remain equal after releasing a lock,it's advisable to only write at the end.

Implementations

impl<T: Write + Read + Seek> IOInterner<T>

pub fn new(x: T) -> Self

Create a new IOInterner that uses as common storage x.

pub fn flush(&self) -> Result<()>

Invokes Write::flush on self.inner.

Panics

This function panics if the Mutex it's poisoned.

pub fn get_or_intern<U: Read + Seek>(&self, buf: U) -> Result<IOEntry<'_, T>>

Creates a new IOEntry object that will be able to generate IOObj that always read same bytes as buf from T so buf will be written at the end if it's not already.

The IOObj does not implement Write as that would mess up equality of two IOEntry instances pointing to the same position with same length which it's actually the comparison algorithm.

Panics

This function panics if the Mutex it's poisoned.