Struct Sequence

pub struct Sequence<'a> { /* private fields */ }

A BAM record sequence.

Implementations

impl<'a> Sequence<'a>

pub fn is_empty(&self) -> bool

Returns whether there are any bases.

pub fn len(&self) -> usize

Returns the number of bases in the sequence.

This is not the length of the buffer.

pub fn get(&self, i: usize) -> Option<u8>

Returns the base at the given index.

pub fn split_at_checked( &'a self, mid: usize, ) -> Option<(Subsequence<'a>, Subsequence<'a>)>

Splits the sequence into two subsequences at the given index.

The left split contains bases from [0, mid); and the right, [mid, len). If mid is

len, this returns None.

pub fn iter(&self) -> impl Iterator<Item = u8> + '_

Returns an iterator over the bases in the sequence.

Trait Implementations

impl<'a> AsRef<[u8]> for Sequence<'a>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for Sequence<'a>

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

Formats the value using the given formatter.

impl<'a> From<Sequence<'a>> for Sequence

fn from(sequence: Sequence<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Sequence<'a>

fn eq(&self, other: &Sequence<'a>) -> 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<'a> Sequence for Sequence<'a>

fn is_empty(&self) -> bool

Returns whether there are any bases.

fn len(&self) -> usize

Returns the number of bases.

fn get(&self, i: usize) -> Option<u8>

Returns the base at the given index.

fn split_at_checked( &self, mid: usize, ) -> Option<(Box<dyn Sequence + '_>, Box<dyn Sequence + '_>)>

Splits the subsequence into two subsequences at the given index.

fn iter(&self) -> Box<dyn Iterator<Item = u8> + '_>

Returns an iterator over bases.

impl<'a> Eq for Sequence<'a>

impl<'a> StructuralPartialEq for Sequence<'a>