Struct Reader

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

Safety

The caller is responsible for ensuring that the bytes slice is valid.

Examples

use core::array;
use solana_bytes_reader::{Reader, ReadBytes};
 
fn main() -> Result<(), Box<dyn std::error::Error>> {
    let bytes: [u8; 32] = array::from_fn(|i| if i % 4 == 0 { i as u8 } else { 0u8 });
     
    let mut reader: Reader = Reader::new(&bytes);
    let first_u32: u32 = reader.read_u32()?;
    let second_u32: u32 = reader.read_u32()?;
    let third_u32: u32 = reader.read_u32()?;
 
    assert_eq!(first_u32, 0u32);
    assert_eq!(second_u32, 4u32);
    assert_eq!(third_u32, 8u32);
     
    Ok(())
}

It’s recommended to initialize Reader and use it’s methods if there are more than 2 method calls.

Otherwise there’s no need in this struct and functions can be used instead.

Implementations

impl<'a> Reader<'a>

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

Panics

if bytes slice is empty.

pub fn new_with_offset(bytes: &'a [u8], offset: usize) -> Self

Panics

if offset equals/greater than bytes slice OR if bytes slice is empty.

pub fn bytes(&self) -> &'a [u8]

pub fn offset(&self) -> usize

pub fn remaining(&self) -> usize

Returns remaining bytes.

pub fn set_offset(&mut self, new_offset: usize)

Panics

if new_offset equals/greater than bytes slice.

Trait Implementations

impl<'a> Clone for Reader<'a>

fn clone(&self) -> Reader<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Reader<'a>

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

Formats the value using the given formatter.

impl PeekIntoBytes for Reader<'_>

type Error = ProgramError

fn peek_u64(&self) -> Result<u64, Self::Error>

Safety

fn peek_i64(&self) -> Result<i64, Self::Error>

Safety

fn peek_u32(&self) -> Result<u32, Self::Error>

Safety

fn peek_i32(&self) -> Result<i32, Self::Error>

Safety

fn peek_u16(&self) -> Result<u16, Self::Error>

Safety

fn peek_i16(&self) -> Result<i16, Self::Error>

Safety

fn peek_bool(&self) -> Result<bool, ProgramError>

Safety

fn peek_u8(&self) -> Result<u8, Self::Error>

Safety

fn peek_i8(&self) -> Result<i8, Self::Error>

Safety

fn peek_bytes<const N: usize>(&self) -> Result<[u8; N], Self::Error>

Peeks into const N amount of bytes.

impl ReadBytes for Reader<'_>

type Error = ProgramError

fn read_u64(&mut self) -> Result<u64, Self::Error>

Safety

fn read_i64(&mut self) -> Result<i64, Self::Error>

Safety

fn read_u32(&mut self) -> Result<u32, Self::Error>

Safety

fn read_i32(&mut self) -> Result<i32, Self::Error>

Safety

fn read_u16(&mut self) -> Result<u16, Self::Error>

Safety

fn read_i16(&mut self) -> Result<i16, Self::Error>

Safety

fn read_bool(&mut self) -> Result<bool, Self::Error>

Safety

fn read_u8(&mut self) -> Result<u8, Self::Error>

Safety

fn read_i8(&mut self) -> Result<i8, Self::Error>

Safety

fn read_bytes<const N: usize>(&mut self) -> Result<[u8; N], Self::Error>

Reads const N amount of bytes.

fn skip(&mut self, bytes_to_skip: usize)

Increments self.offset by bytes_to_skip.

impl<'a> Copy for Reader<'a>