Struct Reader 

pub struct Reader;

A reader for chain files.

Implementations

impl Reader

pub fn from_file<T>(file: T) -> Result<ChainMap>

where T: AsRef<Path> + Debug,

Create a new reader.

Arguments

• file - A path to a chain file.

Returns

A Result containing a FxHashMap of Chain objects.

Example

use chaintools as chain;

let data = chain::Reader::from_file("/path/to/chainfile")?;

pub fn parse(data: &[u8]) -> Result<ChainMap>

Parser for chain files.

Arguments

• data - A reference to a byte slice.

Returns

A Result containing a FxHashMap of Chain objects.

Example

use chaintools as chain;

let data = chain::Reader::parse(&data)?;

pub fn from_bytes(data: &[u8]) -> Result<ChainMap>

Create a new reader from a byte slice.

Arguments

• data - A reference to a byte slice.

Returns

A Result containing a FxHashMap of Chain objects.

Example

use chaintools as chain;

let line = b"chain 4900 chrY 58368225 + 25985403 25985638 chr5 151006098 - 43257292 43257528 1\n9\t1\t0\n\n";
let data = chain::Reader::from_bytes(line)?;

assert_eq!(data.len(), 1);

pub fn from_bin<T>(bin: T) -> Result<ChainMap>

where T: AsRef<Path> + Debug,

Create a new reader from a binary file.

Arguments

• bin - A path to a binary file.

Returns

A Result containing a FxHashMap of Chain objects.

Example

use chaintools as chain;

let data = chain::Reader::from_bin("/path/to/binfile")?;

pub fn load_chain<T>(id: u32, bin: T) -> Result<Chain>

where T: AsRef<Path> + Debug,

Load a single chain from a binary file.

Arguments

• id - A chain id.
• bin - A path to a binary file.

Returns

A Result containing a Chain object.

Example

use chaintools as chain;

let data = chain::Reader::load_chain(&123, "/path/to/binfile")?;

Trait Implementations

impl Clone for Reader

fn clone(&self) -> Reader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Reader

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.