pub struct Leb128Reader<R, P> { /* private fields */ }Expand description
Reader wrapper for LEB128 integers.
The decoding policy is selected by the P type parameter. Use
Leb128Reader<R, NonStrict> for permissive decoding and
Leb128Reader<R, Strict> for canonical-only decoding.
A synchronous read error may occur after part of a value has been consumed. A later call starts at the current input position; it does not resume the failed value. Recover only at a framing boundary or trusted seek checkpoint.
§Target-width integers
usize and isize methods use the current Rust target’s pointer width.
Prefer fixed-width integer methods such as read_u64 or read_i64 for
persistent files and cross-platform protocols.
§Type Parameters
R: Underlying byte input.P: LEB128 canonicality policy.
§Examples
use qubit_codec_binary::NonStrict;
use qubit_io_binary::Leb128Reader;
let mut reader = Leb128Reader::<_, NonStrict>::new(
std::io::Cursor::new([0xAC, 0x02]),
);
assert_eq!(reader.read_u32_non_strict()?, 300);Implementations§
Source§impl<R, P> Leb128Reader<R, P>where
R: ByteInput,
impl<R, P> Leb128Reader<R, P>where
R: ByteInput,
Sourcepub fn is_buffered(&self) -> bool
pub fn is_buffered(&self) -> bool
Returns whether this reader buffers input.
§Returns
Returns true when reads may prefetch bytes into an internal buffer.
Sourcepub unsafe fn read_unchecked(
&mut self,
output: &mut [u8],
index: usize,
count: usize,
) -> Result<usize>
pub unsafe fn read_unchecked( &mut self, output: &mut [u8], index: usize, count: usize, ) -> Result<usize>
Reads up to count bytes into an indexed output range.
§Parameters
output: Destination byte buffer.index: Start of the writable range.count: Maximum number of bytes to read.
§Returns
Returns the number of bytes read; zero indicates end-of-input.
§Errors
Returns the underlying input error.
§Safety
index..index + count must be a valid range within output.
Sourcepub unsafe fn read_fully_unchecked(
&mut self,
output: &mut [u8],
index: usize,
count: usize,
) -> Result<usize>
pub unsafe fn read_fully_unchecked( &mut self, output: &mut [u8], index: usize, count: usize, ) -> Result<usize>
Reads bytes into an indexed range until it is full or EOF.
§Parameters
output: Destination byte buffer.index: Start of the writable range.count: Maximum number of bytes to read.
§Returns
Returns the number of bytes read before the range is full or EOF.
§Errors
Returns the underlying input error.
§Safety
index..index + count must be a valid range within output.
Sourcepub fn read_fully(&mut self, output: &mut [u8]) -> Result<usize>
pub fn read_fully(&mut self, output: &mut [u8]) -> Result<usize>
Source§impl<R, P> Leb128Reader<R, P>where
R: SeekableByteInput,
impl<R, P> Leb128Reader<R, P>where
R: SeekableByteInput,
Sourcepub fn seek_to(&mut self, position: SeekFrom) -> Result<u64>
pub fn seek_to(&mut self, position: SeekFrom) -> Result<u64>
Seeks the wrapped byte stream; see Seekable::seek_to for
the seek contract. Buffered wrappers interpret relative offsets
and report positions relative to their logical stream position.
A position query does not flush buffered output.
§Parameters
position: Relative or absolute target position.
§Returns
Returns the resulting stream position in bytes. For buffered wrappers this is the logical position, including buffered data.
§Errors
Returns the underlying seek error.
Source§impl<R, P> Leb128Reader<R, P>where
P: Leb128DecodePolicy,
impl<R, P> Leb128Reader<R, P>where
P: Leb128DecodePolicy,
Sourcepub const fn is_strict(&self) -> bool
pub const fn is_strict(&self) -> bool
Returns whether this reader rejects non-canonical encodings.
§Returns
Returns true when policy P requires canonical encodings.
Sourcepub fn inner_mut(&mut self) -> &mut R
pub fn inner_mut(&mut self) -> &mut R
Returns an exclusive reference to the underlying reader.
§Returns
Returns mutable access to the wrapped reader.
Sourcepub fn into_inner(self) -> R
pub fn into_inner(self) -> R
Source§impl<R> Leb128Reader<R, NonStrict>where
R: ByteInput,
impl<R> Leb128Reader<R, NonStrict>where
R: ByteInput,
Sourcepub fn read_u8_non_strict(&mut self) -> Result<u8>
pub fn read_u8_non_strict(&mut self) -> Result<u8>
Sourcepub fn read_u16_non_strict(&mut self) -> Result<u16>
pub fn read_u16_non_strict(&mut self) -> Result<u16>
Sourcepub fn read_u32_non_strict(&mut self) -> Result<u32>
pub fn read_u32_non_strict(&mut self) -> Result<u32>
Sourcepub fn read_u64_non_strict(&mut self) -> Result<u64>
pub fn read_u64_non_strict(&mut self) -> Result<u64>
Sourcepub fn read_u128_non_strict(&mut self) -> Result<u128>
pub fn read_u128_non_strict(&mut self) -> Result<u128>
Sourcepub fn read_usize_non_strict(&mut self) -> Result<usize>
pub fn read_usize_non_strict(&mut self) -> Result<usize>
Sourcepub fn read_i8_non_strict(&mut self) -> Result<i8>
pub fn read_i8_non_strict(&mut self) -> Result<i8>
Sourcepub fn read_i16_non_strict(&mut self) -> Result<i16>
pub fn read_i16_non_strict(&mut self) -> Result<i16>
Sourcepub fn read_i32_non_strict(&mut self) -> Result<i32>
pub fn read_i32_non_strict(&mut self) -> Result<i32>
Sourcepub fn read_i64_non_strict(&mut self) -> Result<i64>
pub fn read_i64_non_strict(&mut self) -> Result<i64>
Sourcepub fn read_i128_non_strict(&mut self) -> Result<i128>
pub fn read_i128_non_strict(&mut self) -> Result<i128>
Sourcepub fn read_isize_non_strict(&mut self) -> Result<isize>
pub fn read_isize_non_strict(&mut self) -> Result<isize>
Sourcepub fn read_utf8_string_usize_non_strict(
&mut self,
max_len: usize,
) -> Result<String>
pub fn read_utf8_string_usize_non_strict( &mut self, max_len: usize, ) -> Result<String>
Reads a UTF-8 string prefixed by an unsigned LEB128 byte length.
The length prefix is decoded as usize, so this format is target-width dependent. Prefer a fixed-width length prefix for persistent files and cross-platform protocols.
§Parameters
- max_len: Maximum accepted UTF-8 payload length in bytes.
§Returns
Returns the decoded UTF-8 string.
§Errors
Returns an I/O error for length or payload reads, InvalidData when the encoded length exceeds max_len, or InvalidData when the payload is not valid UTF-8.
§Stream position
If the decoded length exceeds max_len, the length prefix has been
consumed, but the payload remains unread. If UTF-8 validation fails,
the prefix and complete payload have been consumed. These operations
do not roll back; recover only at an outer framing boundary or a
trusted seek checkpoint. See StringReadExt
for the shared length-prefixed read contract.
Sourcepub fn read_utf8_string_u64_non_strict(
&mut self,
max_len: usize,
) -> Result<String>
pub fn read_utf8_string_u64_non_strict( &mut self, max_len: usize, ) -> Result<String>
Reads a UTF-8 string prefixed by an unsigned LEB128 u64 byte length.
Prefer this method over the usize variant for persistent files and cross-platform protocols because the length field is independent of the current Rust target’s pointer width.
§Parameters
- max_len: Maximum accepted UTF-8 payload length in bytes.
§Returns
Returns the decoded UTF-8 string.
§Errors
Returns an input, conversion, or allocation error, or an invalid-data error for a malformed or excessive length or invalid UTF-8.
§Stream position
If the decoded length exceeds max_len, the length prefix has been
consumed, but the payload remains unread. If UTF-8 validation fails,
the prefix and complete payload have been consumed. These operations
do not roll back; recover only at an outer framing boundary or a
trusted seek checkpoint. See StringReadExt
for the shared length-prefixed read contract.
Source§impl<R> Leb128Reader<R, Strict>where
R: ByteInput,
impl<R> Leb128Reader<R, Strict>where
R: ByteInput,
Sourcepub fn read_usize(&mut self) -> Result<usize>
pub fn read_usize(&mut self) -> Result<usize>
Sourcepub fn read_isize(&mut self) -> Result<isize>
pub fn read_isize(&mut self) -> Result<isize>
Sourcepub fn read_utf8_string_usize(&mut self, max_len: usize) -> Result<String>
pub fn read_utf8_string_usize(&mut self, max_len: usize) -> Result<String>
Reads a UTF-8 string prefixed by an unsigned LEB128 byte length.
The length prefix is decoded as usize, so this format is target-width dependent. Prefer a fixed-width length prefix for persistent files and cross-platform protocols.
§Parameters
- max_len: Maximum accepted UTF-8 payload length in bytes.
§Returns
Returns the decoded UTF-8 string.
§Errors
Returns an I/O error for length or payload reads, InvalidData when the encoded length exceeds max_len, or InvalidData when the payload is not valid UTF-8.
§Stream position
If the decoded length exceeds max_len, the length prefix has been
consumed, but the payload remains unread. If UTF-8 validation fails,
the prefix and complete payload have been consumed. These operations
do not roll back; recover only at an outer framing boundary or a
trusted seek checkpoint. See StringReadExt
for the shared length-prefixed read contract.
Sourcepub fn read_utf8_string_u64(&mut self, max_len: usize) -> Result<String>
pub fn read_utf8_string_u64(&mut self, max_len: usize) -> Result<String>
Reads a UTF-8 string prefixed by an unsigned LEB128 u64 byte length.
Prefer this method over the usize variant for persistent files and cross-platform protocols because the length field is independent of the current Rust target’s pointer width.
§Parameters
- max_len: Maximum accepted UTF-8 payload length in bytes.
§Returns
Returns the decoded UTF-8 string.
§Errors
Returns an input, conversion, or allocation error, or an invalid-data error for a malformed or excessive length or invalid UTF-8.
§Stream position
If the decoded length exceeds max_len, the length prefix has been
consumed, but the payload remains unread. If UTF-8 validation fails,
the prefix and complete payload have been consumed. These operations
do not roll back; recover only at an outer framing boundary or a
trusted seek checkpoint. See StringReadExt
for the shared length-prefixed read contract.
Trait Implementations§
Source§impl<R, P> Input for Leb128Reader<R, P>where
R: ByteInput,
impl<R, P> Input for Leb128Reader<R, P>where
R: ByteInput,
Source§fn is_buffered(&self) -> bool
fn is_buffered(&self) -> bool
Reports whether the wrapped input is buffered.
§Returns
Returns the wrapped input’s buffering state.
Source§unsafe fn read_unchecked(
&mut self,
output: &mut [u8],
index: usize,
count: usize,
) -> Result<usize>
unsafe fn read_unchecked( &mut self, output: &mut [u8], index: usize, count: usize, ) -> Result<usize>
Reads up to count bytes into an indexed output range.
§Parameters
output: Destination slice.index: First destination index.count: Maximum number of bytes to read.
§Returns
Returns the number of bytes read.
§Errors
Returns an error reported by the wrapped input.
§Safety
index..index + count must be a valid range within output.
Source§fn into_std_read(self) -> StdRead<Self> ⓘ
fn into_std_read(self) -> StdRead<Self> ⓘ
Source§fn read(&mut self, output: &mut [Self::Item]) -> Result<usize, Error>
fn read(&mut self, output: &mut [Self::Item]) -> Result<usize, Error>
Source§unsafe fn read_fully_unchecked(
&mut self,
output: &mut [Self::Item],
index: usize,
count: usize,
) -> Result<usize, Error>
unsafe fn read_fully_unchecked( &mut self, output: &mut [Self::Item], index: usize, count: usize, ) -> Result<usize, Error>
Source§fn read_fully(&mut self, output: &mut [Self::Item]) -> Result<usize, Error>
fn read_fully(&mut self, output: &mut [Self::Item]) -> Result<usize, Error>
Auto Trait Implementations§
impl<R, P> Freeze for Leb128Reader<R, P>
impl<R, P> RefUnwindSafe for Leb128Reader<R, P>
impl<R, P> Send for Leb128Reader<R, P>
impl<R, P> Sync for Leb128Reader<R, P>
impl<R, P> Unpin for Leb128Reader<R, P>
impl<R, P> UnsafeUnpin for Leb128Reader<R, P>
impl<R, P> UnwindSafe for Leb128Reader<R, P>
Blanket Implementations§
Source§impl<R> BinaryReadExt for R
impl<R> BinaryReadExt for R
Source§fn read_u16(&mut self, byte_order: ByteOrder) -> Result<u16>
fn read_u16(&mut self, byte_order: ByteOrder) -> Result<u16>
Source§fn read_u16_be(&mut self) -> Result<u16>
fn read_u16_be(&mut self) -> Result<u16>
Source§fn read_u16_le(&mut self) -> Result<u16>
fn read_u16_le(&mut self) -> Result<u16>
Source§fn read_u32(&mut self, byte_order: ByteOrder) -> Result<u32>
fn read_u32(&mut self, byte_order: ByteOrder) -> Result<u32>
Source§fn read_u32_be(&mut self) -> Result<u32>
fn read_u32_be(&mut self) -> Result<u32>
Source§fn read_u32_le(&mut self) -> Result<u32>
fn read_u32_le(&mut self) -> Result<u32>
Source§fn read_u64(&mut self, byte_order: ByteOrder) -> Result<u64>
fn read_u64(&mut self, byte_order: ByteOrder) -> Result<u64>
Source§fn read_u64_be(&mut self) -> Result<u64>
fn read_u64_be(&mut self) -> Result<u64>
Source§fn read_u64_le(&mut self) -> Result<u64>
fn read_u64_le(&mut self) -> Result<u64>
Source§fn read_u128(&mut self, byte_order: ByteOrder) -> Result<u128>
fn read_u128(&mut self, byte_order: ByteOrder) -> Result<u128>
Source§fn read_u128_be(&mut self) -> Result<u128>
fn read_u128_be(&mut self) -> Result<u128>
Source§fn read_u128_le(&mut self) -> Result<u128>
fn read_u128_le(&mut self) -> Result<u128>
Source§fn read_i16(&mut self, byte_order: ByteOrder) -> Result<i16>
fn read_i16(&mut self, byte_order: ByteOrder) -> Result<i16>
Source§fn read_i16_le(&mut self) -> Result<i16>
fn read_i16_le(&mut self) -> Result<i16>
Source§fn read_i32(&mut self, byte_order: ByteOrder) -> Result<i32>
fn read_i32(&mut self, byte_order: ByteOrder) -> Result<i32>
Source§fn read_i32_le(&mut self) -> Result<i32>
fn read_i32_le(&mut self) -> Result<i32>
Source§fn read_i64(&mut self, byte_order: ByteOrder) -> Result<i64>
fn read_i64(&mut self, byte_order: ByteOrder) -> Result<i64>
Source§fn read_i64_le(&mut self) -> Result<i64>
fn read_i64_le(&mut self) -> Result<i64>
Source§fn read_i128(&mut self, byte_order: ByteOrder) -> Result<i128>
fn read_i128(&mut self, byte_order: ByteOrder) -> Result<i128>
Source§fn read_i128_be(&mut self) -> Result<i128>
fn read_i128_be(&mut self) -> Result<i128>
Source§fn read_i128_le(&mut self) -> Result<i128>
fn read_i128_le(&mut self) -> Result<i128>
Source§fn read_f32(&mut self, byte_order: ByteOrder) -> Result<f32>
fn read_f32(&mut self, byte_order: ByteOrder) -> Result<f32>
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<T> ByteInput for T
Source§impl<R> Leb128ReadExt for R
impl<R> Leb128ReadExt for R
Source§fn read_uleb_u8_non_strict(&mut self) -> Result<u8>
fn read_uleb_u8_non_strict(&mut self) -> Result<u8>
u8. Read moreSource§fn read_uleb_u16_non_strict(&mut self) -> Result<u16>
fn read_uleb_u16_non_strict(&mut self) -> Result<u16>
u16. Read moreSource§fn read_uleb_u16_strict(&mut self) -> Result<u16>
fn read_uleb_u16_strict(&mut self) -> Result<u16>
u16. Read moreSource§fn read_uleb_u32_non_strict(&mut self) -> Result<u32>
fn read_uleb_u32_non_strict(&mut self) -> Result<u32>
u32. Read moreSource§fn read_uleb_u32_strict(&mut self) -> Result<u32>
fn read_uleb_u32_strict(&mut self) -> Result<u32>
u32. Read moreSource§fn read_uleb_u64_non_strict(&mut self) -> Result<u64>
fn read_uleb_u64_non_strict(&mut self) -> Result<u64>
u64. Read moreSource§fn read_uleb_u64_strict(&mut self) -> Result<u64>
fn read_uleb_u64_strict(&mut self) -> Result<u64>
u64. Read moreSource§fn read_uleb_u128_non_strict(&mut self) -> Result<u128>
fn read_uleb_u128_non_strict(&mut self) -> Result<u128>
u128. Read moreSource§fn read_uleb_u128_strict(&mut self) -> Result<u128>
fn read_uleb_u128_strict(&mut self) -> Result<u128>
u128. Read moreSource§fn read_uleb_usize_non_strict(&mut self) -> Result<usize>
fn read_uleb_usize_non_strict(&mut self) -> Result<usize>
usize. Read moreSource§fn read_uleb_usize_strict(&mut self) -> Result<usize>
fn read_uleb_usize_strict(&mut self) -> Result<usize>
usize. Read moreSource§fn read_sleb_i8_non_strict(&mut self) -> Result<i8>
fn read_sleb_i8_non_strict(&mut self) -> Result<i8>
i8. Read moreSource§fn read_sleb_i16_non_strict(&mut self) -> Result<i16>
fn read_sleb_i16_non_strict(&mut self) -> Result<i16>
i16. Read moreSource§fn read_sleb_i32_non_strict(&mut self) -> Result<i32>
fn read_sleb_i32_non_strict(&mut self) -> Result<i32>
i32. Read moreSource§fn read_sleb_i64_non_strict(&mut self) -> Result<i64>
fn read_sleb_i64_non_strict(&mut self) -> Result<i64>
i64. Read moreSource§fn read_sleb_i128_non_strict(&mut self) -> Result<i128>
fn read_sleb_i128_non_strict(&mut self) -> Result<i128>
i128. Read moreSource§fn read_sleb_i128_strict(&mut self) -> Result<i128>
fn read_sleb_i128_strict(&mut self) -> Result<i128>
i128. Read moreimpl<T> SeekableByteInput for T
impl<T> SeekableInput for T
Source§impl<T> StringReadExt for T
impl<T> StringReadExt for T
Source§fn read_utf8_payload_into(
&mut self,
bytes: &mut Vec<u8>,
len: usize,
max_len: usize,
) -> Result<(), Error>
fn read_utf8_payload_into( &mut self, bytes: &mut Vec<u8>, len: usize, max_len: usize, ) -> Result<(), Error>
Source§fn read_utf8_payload(
&mut self,
len: usize,
max_len: usize,
) -> Result<String, Error>
fn read_utf8_payload( &mut self, len: usize, max_len: usize, ) -> Result<String, Error>
Source§fn read_utf8_string_uleb_usize(
&mut self,
max_len: usize,
) -> Result<String, Error>
fn read_utf8_string_uleb_usize( &mut self, max_len: usize, ) -> Result<String, Error>
Source§fn read_utf8_string_uleb_usize_strict(
&mut self,
max_len: usize,
) -> Result<String, Error>
fn read_utf8_string_uleb_usize_strict( &mut self, max_len: usize, ) -> Result<String, Error>
Source§fn read_utf8_string_uleb_u64(&mut self, max_len: usize) -> Result<String, Error>
fn read_utf8_string_uleb_u64(&mut self, max_len: usize) -> Result<String, Error>
u64 byte-length prefix. Read moreSource§fn read_utf8_string_uleb_u64_strict(
&mut self,
max_len: usize,
) -> Result<String, Error>
fn read_utf8_string_uleb_u64_strict( &mut self, max_len: usize, ) -> Result<String, Error>
u64 byte-length
prefix. Read moreSource§fn read_string_with_u16_len(
&mut self,
byte_order: ByteOrder,
max_len: usize,
) -> Result<String, Error>
fn read_string_with_u16_len( &mut self, byte_order: ByteOrder, max_len: usize, ) -> Result<String, Error>
u16 byte-length prefix. Read moreSource§fn read_string_with_u16_len_be(
&mut self,
max_len: usize,
) -> Result<String, Error>
fn read_string_with_u16_len_be( &mut self, max_len: usize, ) -> Result<String, Error>
u16 byte-length prefix. Read moreSource§fn read_string_with_u16_len_le(
&mut self,
max_len: usize,
) -> Result<String, Error>
fn read_string_with_u16_len_le( &mut self, max_len: usize, ) -> Result<String, Error>
u16 byte-length prefix. Read moreSource§fn read_string_with_u32_len(
&mut self,
byte_order: ByteOrder,
max_len: usize,
) -> Result<String, Error>
fn read_string_with_u32_len( &mut self, byte_order: ByteOrder, max_len: usize, ) -> Result<String, Error>
u32 byte-length prefix. Read moreSource§impl<R> ZigZagReadExt for R
impl<R> ZigZagReadExt for R
Source§fn read_zig_zag_i8_non_strict(&mut self) -> Result<i8>
fn read_zig_zag_i8_non_strict(&mut self) -> Result<i8>
i8. Read moreSource§fn read_zig_zag_i16_non_strict(&mut self) -> Result<i16>
fn read_zig_zag_i16_non_strict(&mut self) -> Result<i16>
i16. Read moreSource§fn read_zig_zag_i32_non_strict(&mut self) -> Result<i32>
fn read_zig_zag_i32_non_strict(&mut self) -> Result<i32>
i32. Read moreSource§fn read_zig_zag_i64_non_strict(&mut self) -> Result<i64>
fn read_zig_zag_i64_non_strict(&mut self) -> Result<i64>
i64. Read moreSource§fn read_zig_zag_i128_non_strict(&mut self) -> Result<i128>
fn read_zig_zag_i128_non_strict(&mut self) -> Result<i128>
i128. Read more