Struct Cursor 

pub struct Cursor<T> { /* private fields */ }

Wraps an in memory buffer providing position functionality for read and write.

Implementations

impl<T: AsRef<[u8]>> Cursor<T>

pub const fn new(inner: T) -> Self

Constructs a new Cursor by wrapping inner.

pub const fn position(&self) -> u64

Returns the position read or written up to thus far.

pub fn set_position(&mut self, position: u64)

Sets the internal position.

This method allows seeking within the wrapped memory by setting the position.

Note that setting a position that is larger than the buffer length will cause reads to succeed by reading zero bytes. Further, writes will be no-op zero length writes.

pub fn into_inner(self) -> T

Returns the inner buffer.

This is the whole wrapped buffer, including the bytes already read.

pub const fn get_ref(&self) -> &T

Returns a reference to the inner buffer.

This is the whole wrapped buffer, including the bytes already read.

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

Returns a mutable reference to the inner buffer.

This is the whole wrapped buffer, including the bytes already read.

pub fn inner(&self) -> &T

👎Deprecated since 0.3.0: use get_ref() instead

Returns a reference to the inner buffer.

This is the whole wrapped buffer, including the bytes already read.

Trait Implementations

impl<T: AsRef<[u8]>> BufRead for Cursor<T>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns data read from this reader, filling the internal buffer if needed.

fn consume(&mut self, amount: usize)

Marks the buffered data up to amount as consumed.

impl<T: Clone> Clone for Cursor<T>

fn clone(&self) -> Cursor<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Cursor<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Cursor<T>

fn default() -> Cursor<T>

Returns the “default value” for a type.

impl<T: PartialEq> PartialEq for Cursor<T>

fn eq(&self, other: &Cursor<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: AsRef<[u8]>> Read for Cursor<T>

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

Reads bytes from source into buf.

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

Reads bytes from source until buf is full.

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

where Self: Sized,

Constructs a new adapter which will read at most limit bytes.

fn read_to_limit(&mut self, buf: &mut Vec<u8>, limit: u64) -> Result<usize>

Attempts to read up to limit bytes from the reader, allocating space in buf as needed.

impl<T: AsMut<[u8]>> Write for Cursor<T>

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

Writes buf 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_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

impl<T: Eq> Eq for Cursor<T>

impl<T> StructuralPartialEq for Cursor<T>