Crate binreader[][src]

Expand description

Helpers to read binary data files in rust

Overview

The binreader crate is designed to make reading binary data easier. It is not meant to replace other wonderful crates like bytes, nom or binread, but instead is meant to work with them as a single, common interface between.

This is primarily done via the BinReader trait, as well as a variety of different implementations of it useful for a variety of purposes.

Feature Flags

As of right now, BinReader only has two feature flags:

  • nom-support which allows nom to parse from BinReaders.
  • memmap which supports platform-independent memory mapped files (via the memmap2 crate).

Modules

util

Structs

RandomAccessBinReader
SliceRefBinReader

A SliceRefBinReader

Enums

Endidness
Error

Traits

BinReader

The primary trait of this crate; a BinReader is designed to be a common interface between your program and binary data.

OwnableBinReader

An implementor of OwnableBinReader owns the data contained within it. This means that they can be built from more from more source (such as a bytes::Bytes instance of a file.

SliceableBinReader

Type Definitions

Result