Struct BioSequence 

pub struct BioSequence { /* private fields */ }

Owned biological sequence data with a descriptive kind.

Implementations

impl BioSequence

pub fn new( kind: SequenceKind, text: impl AsRef<str>, ) -> Result<Self, SequenceError>

Creates a biological sequence from non-empty owned text.

Errors

Returns SequenceError::EmptyText when the supplied text is empty.

pub const fn empty(kind: SequenceKind) -> Self

Creates an explicitly empty sequence with the given kind.

pub const fn kind(&self) -> &SequenceKind

Returns the descriptive sequence kind.

pub const fn text(&self) -> &SequenceText

Returns the owned sequence text wrapper.

pub fn len(&self) -> usize

Returns the number of Unicode scalar values in the sequence text.

pub fn sequence_length(&self) -> SequenceLength

Returns the sequence length wrapper.

pub const fn is_empty(&self) -> bool

Returns true when the sequence text is empty.

pub fn as_str(&self) -> &str

Returns the sequence text.

Trait Implementations

impl Clone for BioSequence

fn clone(&self) -> BioSequence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BioSequence

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

Formats the value using the given formatter.

impl PartialEq for BioSequence

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

impl StructuralPartialEq for BioSequence