Struct Cursor 

pub struct Cursor<'a> { /* private fields */ }

A no-std compatible Cursor for reading from byte slices.

Wraps a &[u8] and tracks a read position, implementing both sync::Read and sync::Seek (when the sync feature is enabled).

Example

use hadris_io::{Cursor, Read, Seek, SeekFrom};

let data = [1u8, 2, 3, 4, 5];
let mut cursor = Cursor::new(&data);

let mut buf = [0u8; 2];
cursor.read_exact(&mut buf).unwrap();
assert_eq!(buf, [1, 2]);

cursor.seek(SeekFrom::Start(0)).unwrap();
cursor.read_exact(&mut buf).unwrap();
assert_eq!(buf, [1, 2]);

Implementations

impl<'a> Cursor<'a>

pub fn new(data: &'a [u8]) -> Self

Creates a new cursor wrapping the given byte slice, starting at position 0.

use hadris_io::Cursor;

let data = [1, 2, 3];
let cursor = Cursor::new(&data);
assert_eq!(cursor.position(), 0);
assert_eq!(cursor.get_ref().len(), 3);

pub fn position(&self) -> usize

Returns the current byte offset within the underlying data.

use hadris_io::Cursor;

let mut cursor = Cursor::new(&[0u8; 10]);
assert_eq!(cursor.position(), 0);
cursor.set_position(5);
assert_eq!(cursor.position(), 5);

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

Sets the cursor position to the given byte offset.

use hadris_io::Cursor;

let mut cursor = Cursor::new(&[0u8; 10]);
cursor.set_position(7);
assert_eq!(cursor.position(), 7);

pub fn get_ref(&self) -> &'a [u8]

Returns a reference to the underlying byte slice.

use hadris_io::Cursor;

let data = [1, 2, 3];
let cursor = Cursor::new(&data);
assert_eq!(cursor.get_ref(), &[1, 2, 3]);

Trait Implementations

impl<'a> Clone for Cursor<'a>

fn clone(&self) -> Cursor<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Cursor<'a>

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

Formats the value using the given formatter.

impl Read for Cursor<'_>

Available on crate feature sync only.

type Error = ErrorKind

Error returned by the underlying source.

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

Read some bytes, returning zero at end of input.

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

Fill buf, retrying interrupted operations.

impl Seek for Cursor<'_>

Available on crate feature sync only.

type Error = ErrorKind

Error returned by the underlying stream.

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

Seek to a new byte position.

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

Return the current byte position.

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

Seek relative to the current byte position.