Struct WriteCursor

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

A cursor for writing bytes to a buffer.

Implementations

impl<'a> WriteCursor<'a>

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

Create a new WriteCursor from a mutable slice of bytes.

pub const fn len(&self) -> usize

Returns the number of bytes remaining.

pub const fn is_empty(&self) -> bool

Returns true if there are no bytes remaining.

pub const fn eof(&self) -> bool

Returns true if there are no bytes remaining.

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

Returns a slice of the remaining bytes.

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

Returns a mutable slice of the remaining bytes.

pub const fn inner(&self) -> &[u8]

Returns the inner byte slice.

pub fn inner_mut(&mut self) -> &mut [u8]

Returns the inner mutable byte slice.

pub const fn pos(&self) -> usize

Returns the current position of the cursor.

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

Write an array of bytes to the buffer.

pub fn write_slice(&mut self, slice: &[u8])

Write a slice of bytes to the buffer.

pub fn write_u8(&mut self, value: u8)

Write a byte to the buffer.

pub fn write_i8(&mut self, value: i8)

Write a signed byte to the buffer.

pub fn write_u16(&mut self, value: u16)

Write a little-endian u16 to the buffer.

pub fn write_u16_be(&mut self, value: u16)

Write a big-endian u16 to the buffer.

pub fn write_i16(&mut self, value: i16)

Write a signed little-endian i16 to the buffer.

pub fn write_i16_be(&mut self, value: i16)

Write a signed big-endian i16 to the buffer.

pub fn write_u32(&mut self, value: u32)

Write a little-endian u32 to the buffer.

pub fn write_u32_be(&mut self, value: u32)

Write a big-endian u32 to the buffer.

pub fn write_i32(&mut self, value: i32)

Write a signed little-endian i32 to the buffer.

pub fn write_u64(&mut self, value: u64)

Write a little-endian u64 to the buffer.

pub fn write_u64_be(&mut self, value: u64)

Write a big-endian u64 to the buffer.

pub fn write_i64(&mut self, value: i64)

Write a signed little-endian i64 to the buffer.

pub fn write_i64_be(&mut self, value: i64)

Write a signed big-endian i64 to the buffer.

pub fn write_u128(&mut self, value: u128)

Write a little-endian u128 to the buffer.

pub fn write_u128_be(&mut self, value: u128)

Write a big-endian u128 to the buffer.

pub fn advance(&mut self, len: usize)

Advance the cursor by len bytes.

pub fn advanced(&'a mut self, len: usize) -> WriteCursor<'a>

Returns a new cursor advanced by len bytes.

pub fn rewind(&mut self, len: usize)

Rewind the cursor by len bytes.

pub fn rewinded(&'a mut self, len: usize) -> WriteCursor<'a>

Returns a new cursor rewinded by len bytes.

Trait Implementations

impl<'a> Debug for WriteCursor<'a>

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

Formats the value using the given formatter.