Struct Record

pub struct Record { /* private fields */ }

Represents a de Bruijn graph record.

Implementations

impl Record

pub fn new(coverage: u16, edges: Option<Edges>) -> Self

Create an empty de Bruijn graph record.

pub fn coverage(&self) -> u16

Return the Record’s coverage.

pub fn fw_coverage(&self) -> u16

Return the Record’s forward coverage.

pub fn rc_coverage(&self) -> u16

Return the Record’s reverse complement coverage.

pub fn edges(&self) -> Edges

pub fn incoming_edges(&self) -> Vec<u8>

Return incoming edges

pub fn outgoing_edges(&self) -> Vec<u8>

Return outgoing edges

pub fn increment_coverage(&mut self)

Increment the coverage value by 1.

pub fn increment_fw_coverage(&mut self)

Increment the forward coverage value by 1.

pub fn increment_rc_coverage(&mut self)

Increment the reverse complement coverage value by 1.

pub fn set_coverage(&mut self, coverage: u16)

Set the coverage value.

pub fn set_incoming_edge(&mut self, nucleotide: u8)

Set incoming edge.

pub fn set_outgoing_edge(&mut self, nucleotide: u8)

Set outgoing edge.

pub fn in_degree(&self) -> u8

The in-degree of a particular k-mer.

pub fn out_degree(&self) -> u8

The out-degree of a particular k-mer.

pub fn is_junction(&self) -> bool

Identifies junctions in the graph

Trait Implementations

impl Clone for Record

fn clone(&self) -> Record

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Record

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

Formats the value using the given formatter.

impl Display for Record

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

Formats the value using the given formatter.

impl PartialEq for Record

fn eq(&self, other: &Record) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Record

impl StructuralPartialEq for Record