Skip to main content

QueryMerFile

Struct QueryMerFile 

Source
pub struct QueryMerFile { /* private fields */ }
Expand description

Random-access query interface for Jellyfish binary/sorted database files.

Uses memory-mapped I/O and matrix-guided binary search for efficient k-mer lookups, matching the behavior of Jellyfish’s C++ binary_query class.

§Examples

use jellyfish_reader::{QueryMerFile, MerDna};

let qf = QueryMerFile::open("output.jf").unwrap();
let mer: MerDna = "ACGTACGTACGTACGTACGTACGTA".parse().unwrap();
match qf.get(&mer) {
    Some(count) => println!("{} appears {} times", mer, count),
    None => println!("{} not found", mer),
}

Implementations§

Source§

impl QueryMerFile

Source

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a Jellyfish database file for random-access queries.

Source

pub fn get(&self, mer: &MerDna) -> Option<u64>

Look up the count for a k-mer. Returns None if not found.

Source

pub fn query(&self, kmer_str: &str) -> Result<Option<u64>>

Query a k-mer given as a string. Convenience method.

Source

pub fn header(&self) -> &FileHeader

Get the file header.

Source

pub fn k(&self) -> usize

K-mer length (number of bases).

Source

pub fn num_records(&self) -> usize

Number of records in the file.

Auto Trait Implementations§

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.