Struct Cursor

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

Emulation of std::io::Cursor

This is not exported to bindings users as serialization is done via a bindings-specific pipeline.

Implementations

impl<T> Cursor<T>

pub fn new(inner: T) -> Cursor<T>

Creates a Cursor by wrapping inner.

pub fn position(&self) -> u64

Returns the position read up to thus far.

pub fn into_inner(self) -> T

Returns the inner buffer.

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

pub fn get_ref(&self) -> &T

Gets a reference to the underlying value in this cursor.

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

Gets a mutable reference to the underlying value in this cursor.

Care should be taken to avoid modifying the internal I/O state of the underlying value as it may corrupt this cursor’s position.

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

Sets the position of this cursor.

Trait Implementations

impl<T> BufRead for Cursor<T>

where T: AsRef<[u8]>,

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

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

fn consume(&mut self, amt: usize)

Marks the buffered data up to amount as consumed.

impl<T> Clone for Cursor<T>

where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Cursor<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Cursor<T>

where T: Default,

fn default() -> Cursor<T>

Returns the “default value” for a type.

impl<T> PartialEq for Cursor<T>

where T: PartialEq,

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> Read for Cursor<T>

where T: AsRef<[u8]>,

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

Reads bytes from source into buf.

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

Reads bytes from source until buf is full.

fn take(&mut self, limit: u64) -> Take<'_, Self>

Creates an adapter which will read at most limit bytes.

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

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

impl<T> Eq for Cursor<T>

where T: Eq,

impl<T> StructuralPartialEq for Cursor<T>