Struct Cursor 

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

A sequential reader over a borrowed slice. It advances only after a successful read or seek, so a refused read leaves it where it was.

Implementations

impl Cursor<'_>

pub fn u16(&mut self, e: Endian) -> Result<u16, BoundsError>

The next u16, in byte order e.

pub fn i16(&mut self, e: Endian) -> Result<i16, BoundsError>

The next i16, in byte order e.

pub fn u32(&mut self, e: Endian) -> Result<u32, BoundsError>

The next u32, in byte order e.

pub fn i32(&mut self, e: Endian) -> Result<i32, BoundsError>

The next i32, in byte order e.

pub fn u64(&mut self, e: Endian) -> Result<u64, BoundsError>

The next u64, in byte order e.

pub fn i64(&mut self, e: Endian) -> Result<i64, BoundsError>

The next i64, in byte order e.

pub fn f32(&mut self, e: Endian) -> Result<f32, BoundsError>

The next f32, in byte order e.

pub fn f64(&mut self, e: Endian) -> Result<f64, BoundsError>

The next f64, in byte order e.

impl<'a> Cursor<'a>

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

A cursor at the start of data, whose first byte is offset 0 of the file.

pub fn with_origin(data: &'a [u8], origin: usize) -> Self

A cursor at the start of data, whose first byte is offset origin of the file.

pub fn position(&self) -> usize

The offset of the next byte to read, within the cursor’s data.

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

All the bytes it reads, from its start (a parser that looks back or ahead by offset).

pub fn remaining(&self) -> usize

How many bytes are left after the position.

pub fn take(&mut self, length: usize) -> Result<&'a [u8], BoundsError>

The next length bytes.

pub fn take_to(&mut self, end: usize) -> Result<&'a [u8], BoundsError>

The bytes from the position up to end (an offset in the view), the cursor left at end: refused when end is before the position or past the view.

pub fn seek(&mut self, offset: usize) -> Result<(), BoundsError>

Moves to offset (the end of the data is allowed); an offset past it is refused.

pub fn array<const N: usize>(&mut self) -> Result<[u8; N], BoundsError>

The next N bytes.

pub fn u8(&mut self) -> Result<u8, BoundsError>

The next byte.

pub fn i8(&mut self) -> Result<i8, BoundsError>

The next byte, signed.

pub fn count(&mut self, e: Endian, each: usize) -> Result<usize, BoundsError>

A u32 count, in byte order e, of records of each bytes that the rest of the view holds; a count it can’t hold is refused, its span’s error naming where the records would start, and the cursor stays before the count. A zero each bounds nothing (checked_span).

Trait Implementations

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

fn clone(&self) -> Self

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.