Struct yaxpeax_arch::U8Reader

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

a struct for Reader impls that can operate on units of u8.

Implementations

impl<'a> U8Reader<'a>

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

Trait Implementations

impl Reader<u16, U16be> for U8Reader<'_>

fn next(&mut self) -> Result<U16be, ReadError>

fn next_n(&mut self, buf: &mut [U16be]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u16

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u16

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u16, U16le> for U8Reader<'_>

fn next(&mut self) -> Result<U16le, ReadError>

fn next_n(&mut self, buf: &mut [U16le]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u16

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u16

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u16, U32be> for U8Reader<'_>

fn next(&mut self) -> Result<U32be, ReadError>

fn next_n(&mut self, buf: &mut [U32be]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u16

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u16

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u16, U32le> for U8Reader<'_>

fn next(&mut self) -> Result<U32le, ReadError>

fn next_n(&mut self, buf: &mut [U32le]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u16

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u16

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u16, U64be> for U8Reader<'_>

fn next(&mut self) -> Result<U64be, ReadError>

fn next_n(&mut self, buf: &mut [U64be]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u16

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u16

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u16, U64le> for U8Reader<'_>

fn next(&mut self) -> Result<U64le, ReadError>

fn next_n(&mut self, buf: &mut [U64le]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u16

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u16

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u16, u8> for U8Reader<'_>

fn next(&mut self) -> Result<u8, ReadError>

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

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u16

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u16

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u32, U16be> for U8Reader<'_>

fn next(&mut self) -> Result<U16be, ReadError>

fn next_n(&mut self, buf: &mut [U16be]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u32

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u32

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u32, U16le> for U8Reader<'_>

fn next(&mut self) -> Result<U16le, ReadError>

fn next_n(&mut self, buf: &mut [U16le]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u32

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u32

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u32, U32be> for U8Reader<'_>

fn next(&mut self) -> Result<U32be, ReadError>

fn next_n(&mut self, buf: &mut [U32be]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u32

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u32

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u32, U32le> for U8Reader<'_>

fn next(&mut self) -> Result<U32le, ReadError>

fn next_n(&mut self, buf: &mut [U32le]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u32

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u32

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u32, U64be> for U8Reader<'_>

fn next(&mut self) -> Result<U64be, ReadError>

fn next_n(&mut self, buf: &mut [U64be]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u32

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u32

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u32, U64le> for U8Reader<'_>

fn next(&mut self) -> Result<U64le, ReadError>

fn next_n(&mut self, buf: &mut [U64le]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u32

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u32

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u32, u8> for U8Reader<'_>

fn next(&mut self) -> Result<u8, ReadError>

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

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u32

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u32

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u64, U16be> for U8Reader<'_>

fn next(&mut self) -> Result<U16be, ReadError>

fn next_n(&mut self, buf: &mut [U16be]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u64

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u64

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u64, U16le> for U8Reader<'_>

fn next(&mut self) -> Result<U16le, ReadError>

fn next_n(&mut self, buf: &mut [U16le]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u64

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u64

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u64, U32be> for U8Reader<'_>

fn next(&mut self) -> Result<U32be, ReadError>

fn next_n(&mut self, buf: &mut [U32be]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u64

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u64

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u64, U32le> for U8Reader<'_>

fn next(&mut self) -> Result<U32le, ReadError>

fn next_n(&mut self, buf: &mut [U32le]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u64

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u64

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u64, U64be> for U8Reader<'_>

fn next(&mut self) -> Result<U64be, ReadError>

fn next_n(&mut self, buf: &mut [U64be]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u64

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u64

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u64, U64le> for U8Reader<'_>

fn next(&mut self) -> Result<U64le, ReadError>

fn next_n(&mut self, buf: &mut [U64le]) -> Result<(), ReadError>

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u64

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u64

the difference, in Address, between the current Reader position and the initial offset when constructed.

impl Reader<u64, u8> for U8Reader<'_>

fn next(&mut self) -> Result<u8, ReadError>

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

read buf-many items from this reader in bulk. if Reader cannot read buf-many items, return ReadError::ExhaustedInput.

fn mark(&mut self)

mark the current position as where to measure offset against.

fn offset(&mut self) -> u64

the difference, in Address, between the current Reader position and its last mark. when created, a Reader’s initial position is marked, so creating a Reader and immediately calling offset() must return Address::zero().

fn total_offset(&mut self) -> u64

the difference, in Address, between the current Reader position and the initial offset when constructed.