Struct io_interner::IOInterner

pub struct IOInterner<T: Write + Read + Seek + ?Sized> {
    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 data pointed by existing [IOEntry] instances would change and thus the comparison algorithm would mess up if you do not ensure that already existing 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 from_buf<U>(x: U) -> IOInterner<Cursor<U>> where Cursor<U>: Write + Read + Seek,

Create a new IOInterner that uses as common storage x.

pub fn map<U: Write + Read + Seek, F: FnOnce(T) -> U>( self, f: F ) -> Result<IOInterner<U>, PoisonError<T>>

Returns an IOInterner<U> after applying the closure f to it’s inner value.

Errors

See Mutex::into_inner.

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

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

Like Self::get_or_intern instead that will return also a bool indicating whether the entry was not there before.

Errors

See Self::get_or_intern.

pub fn get_or_intern<U: Read + Seek>(&self, buf: U) -> Result<IOObj<'_, 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.

The cursor of the inner Mutex<T> field it’s setted at final of the IOPos returned which would be at final if the data had to be written.

Errors

This function returns any io::Error that could result from [seek] and [read] operation applied to buf or any [seek],[read] or write one applied to self.inner.

Panics

This function panics if the Mutex it’s poisoned.

Race conditions

if a &File it’s passed down as buf,the length of the file it’s readed at init and while comparing the contents new bytes added thought another &File gotta be ignored.

seek write read

pub fn get_or_intern_bytes( &self, bytes: impl AsRef<[u8]> ) -> Result<IOObj<'_, T>>

Convenience for self.get_or_intern(io::Cursor::new(bytes)).

pub fn try_intern_bytes( &self, bytes: impl AsRef<[u8]> ) -> Result<(IOObj<'_, T>, bool)>

Convenience for self.try_intern(io::Cursor::new(bytes)).

pub fn get_pos(&self, pos: IOPos) -> IOObj<'_, T>

Creates an IOObj out it’s first IOPos.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Write + Read + Seek + ?Sized> Debug for IOInterner<T>

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

Formats the value using the given formatter.

impl<T: Default + Write + Read + Seek + ?Sized> Default for IOInterner<T>

fn default() -> IOInterner<T>

Returns the “default value” for a type.

impl<'a, T: Write + Read + Seek + ?Sized> Read for &'a IOInterner<T>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<T: Write + Read + Seek + ?Sized> Read for IOInterner<T>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

impl<'a, T: Write + Read + Seek + ?Sized> Seek for &'a IOInterner<T>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

impl<T: Write + Read + Seek + ?Sized> Seek for IOInterner<T>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

impl<'a, T: Write + Read + Seek + ?Sized> Write for &'a IOInterner<T>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<T: Write + Read + Seek + ?Sized> Write for IOInterner<T>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.