Struct Link

pub struct Link {
    pub is_forward: bool,
    pub junctions: VecDeque<u8>,
}

Represents metadata on a link (a series of junction choices in de Bruijn graph).

Fields

is_forward: bool

junctions: VecDeque<u8>

Implementations

impl Link

pub fn new(is_forward: bool) -> Self

Create an empty link record.

pub fn from_junctions(is_forward: bool, seq: &[u8]) -> Self

Create a link from a sequence of junction choices.

pub fn is_forward(&self) -> bool

Return orientation of the link.

pub fn len(&self) -> usize

Return the number of junction choices in the link.

pub fn is_empty(&self) -> bool

Indicate whether the list of junctions is empty.

pub fn push_back(&mut self, junction: u8)

Add a junction to the queue.

pub fn front(&self) -> Option<&u8>

Peek at a junction from the front of the queue.

pub fn pop_front(&mut self) -> Option<u8>

Take a junction from the front of the queue.

pub fn complement(&self) -> Link

Return a new link with the junction choices complemented.

Trait Implementations

impl Clone for Link

fn clone(&self) -> Link

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Link

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

Formats the value using the given formatter.

impl Display for Link

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

Formats the value using the given formatter.

impl Hash for Link

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Link

fn cmp(&self, other: &Link) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Link

fn eq(&self, other: &Link) -> 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 PartialOrd for Link

fn partial_cmp(&self, other: &Link) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Link

impl StructuralPartialEq for Link