Struct SharedMultistreamIO

pub struct SharedMultistreamIO<R, W, RW>(/* private fields */)
where
    R: Read + Seek + Debug,
    W: Write + Seek + Debug,
    RW: Read + Write + Seek + Debug;

• The shared version of the MultistreamIO.
• Because it’s shared, when the 3rd library owned it, we still can access to it, e.g. switch it to a cursor stream to capture some data.

Implementations

impl<R, W, RW> SharedMultistreamIO<R, W, RW>

where R: Read + Seek + Debug, W: Write + Seek + Debug, RW: Read + Write + Seek + Debug,

pub fn new(writer_with_cursor: MultistreamIO<R, W, RW>) -> Self

Methods from Deref<Target = MultistreamIO<R, W, RW>>

pub fn get_cur_stream(&self) -> &StreamType<R, W, RW>

• Get the current selected stream object

pub fn get_cur_stream_mut(&mut self) -> &mut StreamType<R, W, RW>

• Get the current selected stream object as mutable

pub fn get_stream(&self, index: usize) -> &StreamType<R, W, RW>

• Get a stream object using an index

pub fn get_stream_mut(&mut self, index: usize) -> &mut StreamType<R, W, RW>

• Get a mutable stream object using an index

pub fn push_stream(&mut self, stream: StreamType<R, W, RW>)

• Add a new stream

pub fn pop_stream(&mut self) -> Option<StreamType<R, W, RW>>

• Pop out the last stream

pub fn set_stream(&mut self, index: usize)

• Set the current stream index

pub fn len(&self) -> usize

• The number of streams in total

pub fn is_empty(&self) -> bool

• Is there no stream objects?

Trait Implementations

impl<R, W, RW> Clone for SharedMultistreamIO<R, W, RW>

where R: Read + Seek + Debug, W: Write + Seek + Debug, RW: Read + Write + Seek + Debug,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R, W, RW> Debug for SharedMultistreamIO<R, W, RW>

where R: Read + Seek + Debug + Debug, W: Write + Seek + Debug + Debug, RW: Read + Write + Seek + Debug + Debug,

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

Formats the value using the given formatter.

impl<R, W, RW> Default for SharedMultistreamIO<R, W, RW>

where R: Read + Seek + Debug, W: Write + Seek + Debug, RW: Read + Write + Seek + Debug,

fn default() -> Self

Returns the “default value” for a type.

impl<R, W, RW> Deref for SharedMultistreamIO<R, W, RW>

where R: Read + Seek + Debug, W: Write + Seek + Debug, RW: Read + Write + Seek + Debug,

type Target = MultistreamIO<R, W, RW>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<R, W, RW> DerefMut for SharedMultistreamIO<R, W, RW>

where R: Read + Seek + Debug, W: Write + Seek + Debug, RW: Read + Write + Seek + Debug,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<R, W, RW> Read for SharedMultistreamIO<R, W, RW>

where R: Read + Seek + Debug, W: Write + Seek + Debug, RW: Read + Write + Seek + Debug,

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>) -> Result<usize, Error>

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

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

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

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

Reads 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)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where 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<R, W, RW> Seek for SharedMultistreamIO<R, W, RW>

where R: Read + Seek + Debug, W: Write + Seek + Debug, RW: Read + Write + Seek + Debug,

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.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl<R, W, RW> Write for SharedMultistreamIO<R, W, RW>

where R: Read + Seek + Debug, W: Write + Seek + Debug, RW: Read + Write + Seek + Debug,

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

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

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

Flushes 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, args: Arguments<'_>) -> Result<(), Error>

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

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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