Struct simple_bytes::Offset

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

A struct which holds a specific offset for any BytesRead, BytesWrite or BytesSeek implementation.

Example

let mut offset = Offset::new(BytesOwned::from(vec![1, 2, 3, 4]), 2);
assert_eq!(offset.as_slice(), &[3, 4]);
assert_eq!(offset.remaining(), &[3, 4]);
offset.write_u8(5);
assert_eq!(offset.as_slice(), &[5, 4]);
assert_eq!(offset.remaining(), &[4]);
offset.seek(2);
offset.write_u8(5);
assert_eq!(offset.as_slice(), &[5, 4, 5]);

Implementations

impl<T> Offset<T>

pub fn new(inner: T, offset: usize) -> Self where
    T: BytesRead + BytesSeek, 

Creates a new Cursor.

May panic if the offset is bigger than the inner len. Depending on inner.

pub fn set_offset(&mut self, offset: usize) where
    T: BytesSeek, 

Updates the offset.

Maybe panic if there aren’t enough bytes left.

pub fn offset(&self) -> usize

Returns the current offset.

pub fn inner(&self) -> &T

Returns the inner value as a reference.

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

Returns the inner value as a mutable reference. Shrinking the inner len or updating the position may lead to panics when reading or writing.

pub fn into_inner(self) -> T

Returns the inner value, discarding the offset.

Trait Implementations

impl<T> BytesRead for Offset<T> where
    T: BytesRead, 

fn as_slice(&self) -> &[u8]

Returns the entire slice.

fn remaining(&self) -> &[u8]

Returns all remaining bytes.

fn try_read(&mut self, len: usize) -> Result<&[u8], ReadError>

Try to read a given length of bytes.

fn peek(&self, len: usize) -> Option<&[u8]>

Tries to read a given length without updating the internal position. Returns None if there are not enought bytes remaining.

fn len(&self) -> usize

Returns the length of the entire slice.

fn read(&mut self, len: usize) -> &[u8]

Reads a given length of bytes.

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

Try to read 1 bytes in big-endian converting them into an u8.

fn read_u8(&mut self) -> u8

Reads 1 bytes in big-endian converting them into an u8.

fn try_read_u16(&mut self) -> Result<u16, ReadError>

Try to read 2 bytes in big-endian converting them into an u16.

fn read_u16(&mut self) -> u16

Reads 2 bytes in big-endian converting them into an u16.

fn try_read_u32(&mut self) -> Result<u32, ReadError>

Try to read 4 bytes in big-endian converting them into an u32.

fn read_u32(&mut self) -> u32

Reads 4 bytes in big-endian converting them into an u32.

fn try_read_u64(&mut self) -> Result<u64, ReadError>

Try to read 8 bytes in big-endian converting them into an u64.

fn read_u64(&mut self) -> u64

Reads 8 bytes in big-endian converting them into an u64.

fn try_read_u128(&mut self) -> Result<u128, ReadError>

Try to read 16 bytes in big-endian converting them into an u128.

fn read_u128(&mut self) -> u128

Reads 16 bytes in big-endian converting them into an u128.

fn try_read_i8(&mut self) -> Result<i8, ReadError>

Try to read 1 bytes in big-endian converting them into an i8.

fn read_i8(&mut self) -> i8

Reads 1 bytes in big-endian converting them into an i8.

fn try_read_i16(&mut self) -> Result<i16, ReadError>

Try to read 2 bytes in big-endian converting them into an i16.

fn read_i16(&mut self) -> i16

Reads 2 bytes in big-endian converting them into an i16.

fn try_read_i32(&mut self) -> Result<i32, ReadError>

Try to read 4 bytes in big-endian converting them into an i32.

fn read_i32(&mut self) -> i32

Reads 4 bytes in big-endian converting them into an i32.

fn try_read_i64(&mut self) -> Result<i64, ReadError>

Try to read 8 bytes in big-endian converting them into an i64.

fn read_i64(&mut self) -> i64

Reads 8 bytes in big-endian converting them into an i64.

fn try_read_i128(&mut self) -> Result<i128, ReadError>

Try to read 16 bytes in big-endian converting them into an i128.

fn read_i128(&mut self) -> i128

Reads 16 bytes in big-endian converting them into an i128.

fn try_read_f32(&mut self) -> Result<f32, ReadError>

Try to read 4 bytes in big-endian converting them into an f32.

fn read_f32(&mut self) -> f32

Reads 4 bytes in big-endian converting them into an f32.

fn try_read_f64(&mut self) -> Result<f64, ReadError>

Try to read 8 bytes in big-endian converting them into an f64.

fn read_f64(&mut self) -> f64

Reads 8 bytes in big-endian converting them into an f64.

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

Try to read 1 bytes in little-endian converting them into an u8.

fn read_le_u8(&mut self) -> u8

Reads 1 bytes in little-endian converting them into an u8.

fn try_read_le_u16(&mut self) -> Result<u16, ReadError>

Try to read 2 bytes in little-endian converting them into an u16.

fn read_le_u16(&mut self) -> u16

Reads 2 bytes in little-endian converting them into an u16.

fn try_read_le_u32(&mut self) -> Result<u32, ReadError>

Try to read 4 bytes in little-endian converting them into an u32.

fn read_le_u32(&mut self) -> u32

Reads 4 bytes in little-endian converting them into an u32.

fn try_read_le_u64(&mut self) -> Result<u64, ReadError>

Try to read 8 bytes in little-endian converting them into an u64.

fn read_le_u64(&mut self) -> u64

Reads 8 bytes in little-endian converting them into an u64.

fn try_read_le_u128(&mut self) -> Result<u128, ReadError>

Try to read 16 bytes in little-endian converting them into an u128.

fn read_le_u128(&mut self) -> u128

Reads 16 bytes in little-endian converting them into an u128.

fn try_read_le_i8(&mut self) -> Result<i8, ReadError>

Try to read 1 bytes in little-endian converting them into an i8.

fn read_le_i8(&mut self) -> i8

Reads 1 bytes in little-endian converting them into an i8.

fn try_read_le_i16(&mut self) -> Result<i16, ReadError>

Try to read 2 bytes in little-endian converting them into an i16.

fn read_le_i16(&mut self) -> i16

Reads 2 bytes in little-endian converting them into an i16.

fn try_read_le_i32(&mut self) -> Result<i32, ReadError>

Try to read 4 bytes in little-endian converting them into an i32.

fn read_le_i32(&mut self) -> i32

Reads 4 bytes in little-endian converting them into an i32.

fn try_read_le_i64(&mut self) -> Result<i64, ReadError>

Try to read 8 bytes in little-endian converting them into an i64.

fn read_le_i64(&mut self) -> i64

Reads 8 bytes in little-endian converting them into an i64.

fn try_read_le_i128(&mut self) -> Result<i128, ReadError>

Try to read 16 bytes in little-endian converting them into an i128.

fn read_le_i128(&mut self) -> i128

Reads 16 bytes in little-endian converting them into an i128.

fn try_read_le_f32(&mut self) -> Result<f32, ReadError>

Try to read 4 bytes in little-endian converting them into an f32.

fn read_le_f32(&mut self) -> f32

Reads 4 bytes in little-endian converting them into an f32.

fn try_read_le_f64(&mut self) -> Result<f64, ReadError>

Try to read 8 bytes in little-endian converting them into an f64.

fn read_le_f64(&mut self) -> f64

Reads 8 bytes in little-endian converting them into an f64.

impl<T> BytesSeek for Offset<T> where
    T: BytesSeek, 

fn position(&self) -> usize

Returns the internal position.

fn try_seek(&mut self, pos: usize) -> Result<(), SeekError>

Sets the internal position.

Panics

Depending on the implementation.

fn seek(&mut self, pos: usize)

Sets the internal position.

fn try_advance(&mut self, adv: usize) -> Result<(), SeekError>

Advances the internal position if possible.

fn advance(&mut self, adv: usize)

Advances the internal position.

impl<T> BytesWrite for Offset<T> where
    T: BytesWrite, 

fn as_mut(&mut self) -> &mut [u8]

Returns the entire slice mutably.

fn as_bytes(&self) -> Bytes<'_>

Returns the entire slice as a bytes struct setting the position of the new Bytes to 0.

fn remaining_mut(&mut self) -> &mut [u8]

Returns the remaining bytes mutably.

fn try_write(&mut self, slice: impl AsRef<[u8]>) -> Result<(), WriteError>

Writes a slice.

fn write(&mut self, slice: impl AsRef<[u8]>)

Writes a slice.

fn try_write_u8(&mut self, num: u8) -> Result<(), WriteError>

Try to write u8 in big-endian.`

fn write_u8(&mut self, num: u8)

Writes an u8 in big-endian.

fn try_write_u16(&mut self, num: u16) -> Result<(), WriteError>

Try to write u16 in big-endian.`

fn write_u16(&mut self, num: u16)

Writes an u16 in big-endian.

fn try_write_u32(&mut self, num: u32) -> Result<(), WriteError>

Try to write u32 in big-endian.`

fn write_u32(&mut self, num: u32)

Writes an u32 in big-endian.

fn try_write_u64(&mut self, num: u64) -> Result<(), WriteError>

Try to write u64 in big-endian.`

fn write_u64(&mut self, num: u64)

Writes an u64 in big-endian.

fn try_write_u128(&mut self, num: u128) -> Result<(), WriteError>

Try to write u128 in big-endian.`

fn write_u128(&mut self, num: u128)

Writes an u128 in big-endian.

fn try_write_i8(&mut self, num: i8) -> Result<(), WriteError>

Try to write i8 in big-endian.`

fn write_i8(&mut self, num: i8)

Writes an i8 in big-endian.

fn try_write_i16(&mut self, num: i16) -> Result<(), WriteError>

Try to write i16 in big-endian.`

fn write_i16(&mut self, num: i16)

Writes an i16 in big-endian.

fn try_write_i32(&mut self, num: i32) -> Result<(), WriteError>

Try to write i32 in big-endian.`

fn write_i32(&mut self, num: i32)

Writes an i32 in big-endian.

fn try_write_i64(&mut self, num: i64) -> Result<(), WriteError>

Try to write i64 in big-endian.`

fn write_i64(&mut self, num: i64)

Writes an i64 in big-endian.

fn try_write_i128(&mut self, num: i128) -> Result<(), WriteError>

Try to write i128 in big-endian.`

fn write_i128(&mut self, num: i128)

Writes an i128 in big-endian.

fn try_write_f32(&mut self, num: f32) -> Result<(), WriteError>

Try to write f32 in big-endian.`

fn write_f32(&mut self, num: f32)

Writes an f32 in big-endian.

fn try_write_f64(&mut self, num: f64) -> Result<(), WriteError>

Try to write f64 in big-endian.`

fn write_f64(&mut self, num: f64)

Writes an f64 in big-endian.

fn try_write_le_u8(&mut self, num: u8) -> Result<(), WriteError>

Try to write u8 in little-endian.`

fn write_le_u8(&mut self, num: u8)

Writes an u8 in little-endian.

fn try_write_le_u16(&mut self, num: u16) -> Result<(), WriteError>

Try to write u16 in little-endian.`

fn write_le_u16(&mut self, num: u16)

Writes an u16 in little-endian.

fn try_write_le_u32(&mut self, num: u32) -> Result<(), WriteError>

Try to write u32 in little-endian.`

fn write_le_u32(&mut self, num: u32)

Writes an u32 in little-endian.

fn try_write_le_u64(&mut self, num: u64) -> Result<(), WriteError>

Try to write u64 in little-endian.`

fn write_le_u64(&mut self, num: u64)

Writes an u64 in little-endian.

fn try_write_le_u128(&mut self, num: u128) -> Result<(), WriteError>

Try to write u128 in little-endian.`

fn write_le_u128(&mut self, num: u128)

Writes an u128 in little-endian.

fn try_write_le_i8(&mut self, num: i8) -> Result<(), WriteError>

Try to write i8 in little-endian.`

fn write_le_i8(&mut self, num: i8)

Writes an i8 in little-endian.

fn try_write_le_i16(&mut self, num: i16) -> Result<(), WriteError>

Try to write i16 in little-endian.`

fn write_le_i16(&mut self, num: i16)

Writes an i16 in little-endian.

fn try_write_le_i32(&mut self, num: i32) -> Result<(), WriteError>

Try to write i32 in little-endian.`

fn write_le_i32(&mut self, num: i32)

Writes an i32 in little-endian.

fn try_write_le_i64(&mut self, num: i64) -> Result<(), WriteError>

Try to write i64 in little-endian.`

fn write_le_i64(&mut self, num: i64)

Writes an i64 in little-endian.

fn try_write_le_i128(&mut self, num: i128) -> Result<(), WriteError>

Try to write i128 in little-endian.`

fn write_le_i128(&mut self, num: i128)

Writes an i128 in little-endian.

fn try_write_le_f32(&mut self, num: f32) -> Result<(), WriteError>

Try to write f32 in little-endian.`

fn write_le_f32(&mut self, num: f32)

Writes an f32 in little-endian.

fn try_write_le_f64(&mut self, num: f64) -> Result<(), WriteError>

Try to write f64 in little-endian.`

fn write_le_f64(&mut self, num: f64)

Writes an f64 in little-endian.

impl<T: Clone> Clone for Offset<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Offset<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Offset<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq<Offset<T>> for Offset<T>

fn eq(&self, other: &Offset<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Offset<T>) -> bool

This method tests for !=.

impl<T: Copy> Copy for Offset<T>

impl<T: Eq> Eq for Offset<T>

impl<T> StructuralEq for Offset<T>

impl<T> StructuralPartialEq for Offset<T>