SliceReader

Struct SliceReader 

Source
pub struct SliceReader<'de> { /* private fields */ }
Expand description

An efficient Reader wrapper around a slice.

Implementations§

Source§

impl<'de> SliceReader<'de>

Source

pub fn new(slice: &'de [u8]) -> Self

Construct a new instance around the specified slice.

Source

pub fn as_slice(&self) -> &'de [u8]

Get the remaining contents of the reader as a slice.

§Examples
use musli::Context;
use musli::reader::{Reader, SliceReader};

fn process<C>(cx: C) -> Result<(), C::Error>
where
    C: Context
{
    let mut reader = SliceReader::new(&[1, 2, 3, 4]);
    assert_eq!(reader.as_slice(), &[1, 2, 3, 4]);
    reader.skip(cx, 2)?;
    assert_eq!(reader.as_slice(), &[3, 4]);
    Ok(())
}
Source

pub fn remaining(&self) -> usize

Get remaining bytes in the reader.

§Examples
use musli::Context;
use musli::reader::{Reader, SliceReader};

fn process<C>(cx: C) -> Result<(), C::Error>
where
    C: Context
{
    let mut reader = SliceReader::new(&[1, 2, 3, 4]);
    assert_eq!(reader.remaining(), 4);
    reader.skip(cx, 2);
    assert_eq!(reader.remaining(), 2);
    Ok(())
}

Trait Implementations§

Source§

impl<'de> Reader<'de> for SliceReader<'de>

Source§

type Mut<'this> = &'this mut SliceReader<'de> where Self: 'this

Type borrowed from self. Read more
Source§

type TryClone = SliceReader<'de>

Type that can be cloned from the reader.
Source§

fn borrow_mut(&mut self) -> Self::Mut<'_>

Borrow the current reader.
Source§

fn try_clone(&self) -> Option<Self::TryClone>

Try to clone the reader.
Source§

fn is_eof(&mut self) -> bool

Test if the reader is at end of input.
Source§

fn skip<C>(&mut self, cx: C, n: usize) -> Result<(), C::Error>
where C: Context,

Skip over the given number of bytes.
Source§

fn read_bytes<C, V>( &mut self, cx: C, n: usize, visitor: V, ) -> Result<V::Ok, V::Error>
where C: Context, V: UnsizedVisitor<'de, C, [u8], Error = C::Error, Allocator = C::Allocator>,

Read a slice out of the current reader.
Source§

unsafe fn read_bytes_uninit<C>( &mut self, cx: C, ptr: *mut u8, n: usize, ) -> Result<(), C::Error>
where C: Context,

Read into the given buffer which might not have been initialized. Read more
Source§

fn peek(&mut self) -> Option<u8>

Peek the next value.
Source§

fn read<C>(&mut self, cx: C, buf: &mut [u8]) -> Result<(), C::Error>
where C: Context,

Read a slice into the given buffer.
Source§

fn read_byte<C>(&mut self, cx: C) -> Result<u8, C::Error>
where C: Context,

Read a single byte.
Source§

fn read_array<C, const N: usize>(&mut self, cx: C) -> Result<[u8; N], C::Error>
where C: Context,

Read an array out of the current reader.
Source§

fn limit(self, limit: usize) -> Limit<Self>
where Self: Sized,

Keep an accurate record of the position within the reader.
Source§

impl Send for SliceReader<'_>

Source§

impl Sync for SliceReader<'_>

Auto Trait Implementations§

§

impl<'de> Freeze for SliceReader<'de>

§

impl<'de> RefUnwindSafe for SliceReader<'de>

§

impl<'de> Unpin for SliceReader<'de>

§

impl<'de> UnwindSafe for SliceReader<'de>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.