Struct snowbinary::SnowBinReader

pub struct SnowBinReader { /* private fields */ }

Allows reading from a SnowBinary file.

Implementations

impl SnowBinReader

pub fn new(path: PathBuf) -> Result<Self, SnowBinError>

Creates a new SnowBinReader. Params are pulled from the file info.

Example

use std::path::PathBuf;

use snowbinary::{SnowBinInfo, SnowBinReader};

let reader = SnowBinReader::new(PathBuf::from("file.temp")).unwrap();

Errors

Returns SnowBinError if the file could not be created or opened, or the file cannot be read from.

pub fn read(&mut self, header: &str) -> Result<Vec<u8>, SnowBinError>

Reads data from the file using the header.

Example

use std::path::PathBuf;

use snowbinary::{SnowBinError, SnowBinInfo, SnowBinReader};

let mut reader = SnowBinReader::new(PathBuf::from("file.temp"));
match &mut reader {
    Ok(reader) => {
        let data = reader.read("Header"); // May return error
    }
    Err(_) => {}
}

Errors

Returns SnowBinError if the file cannot be read from or the end of the file was reached.

Panics

Panics could happen if data size is over i64::MAX.

Trait Implementations

impl Debug for SnowBinReader

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

Formats the value using the given formatter.