Struct bio_seq::seq::SeqSlice

pub struct SeqSlice<A: Codec> { /* private fields */ }

A lightweight, read-only window into part of a sequence

Implementations

impl<'a, A: Codec> SeqSlice<A>

pub fn chain( self: &'a SeqSlice<A>, second: &'a SeqSlice<A> ) -> Chain<SeqIter<'a, A>, SeqIter<'a, A>>

impl<A: Codec> SeqSlice<A>

pub fn kmers<const K: usize>(&self) -> KmerIter<'_, A, K>

Iterate over sliding windows of size K

pub fn rev(&self) -> RevIter<'_, A>

Iterate over the sequence in reverse order

pub fn windows(&self, width: usize) -> SeqChunks<'_, A>

Iterate over the sequence in overlapping windows of a specified width

This will panic if the length of the window is greater than the length of the sequence.

Example:

use bio_seq::prelude::*;

let seq: Seq<Dna> = "ACTGATCG".try_into().unwrap();
let windows: Vec<Seq<Dna>> = seq.windows(3).collect();
assert_eq!(windows, vec!["ACT", "CTG", "TGA", "GAT", "ATC", "TCG"]);

pub fn chunks(&self, width: usize) -> SeqChunks<'_, A>

Iterate over the sequence in non-overlapping chunks of a specified width

The last incomplete chunk will be excluded if the sequence length is not divisible by the specified width.

Example:

use bio_seq::prelude::*;

let seq: Seq<Dna> = "ACTGATCG".try_into().unwrap();
let chunks: Vec<Seq<Dna>> = seq.chunks(3).collect();
assert_eq!(chunks, vec!["ACT", "GAT"]);

impl<A: Codec> SeqSlice<A>

pub fn nth(&self, i: usize) -> A

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn contains(&self, _other: &SeqSlice<A>) -> bool

pub fn bit_and(&self, rhs: &SeqSlice<A>) -> Seq<A>

pub fn bit_or(&self, rhs: &SeqSlice<A>) -> Seq<A>

Trait Implementations

impl<A: Codec> AsRef<SeqSlice<A>> for Seq<A>

A Seq can be borrowed as a SeqSlice through generic constraints.

use bio_seq::prelude::*;

fn count_bases<S: AsRef<SeqSlice<Dna>>>(s: S) -> usize {
   s.as_ref().len()
}

let seq: Seq<Dna> = dna!("CATCGATCGATC");
let count = count_bases(seq); // the AsRef implementation allows us to directly pass a Seq
assert_eq!(count, 12);

fn as_ref(&self) -> &SeqSlice<A>

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

impl BitAnd for &SeqSlice<Iupac>

type Output = Seq<Iupac>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for &SeqSlice<Iupac>

type Output = Seq<Iupac>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<A: Codec> Borrow<SeqSlice<A>> for Seq<A>

Borrow a Seq<A> as a SeqSlice<A>.

The Borrow trait to is used to obtain a reference to a SeqSlice from a Seq, allowing it to be used wherever a SeqSlice is expected.

use bio_seq::prelude::*;
use std::borrow::Borrow;

let seq: Seq<Dna> = dna!("CTACGTACGATCATCG");
let slice: &SeqSlice<Dna> = seq.borrow();

fn borrow(&self) -> &SeqSlice<A>

Immutably borrows from an owned value.

impl<A: Debug + Codec> Debug for SeqSlice<A>

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

Formats the value using the given formatter.

impl<A: Codec> Display for SeqSlice<A>

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

Formats the value using the given formatter.

impl<A: Codec, const K: usize> From<&SeqSlice<A>> for Kmer<A, K>

fn from(slice: &SeqSlice<A>) -> Self

Converts to this type from the input type.

impl<A: Codec> From<&SeqSlice<A>> for Seq<A>

fn from(slice: &SeqSlice<A>) -> Self

Converts to this type from the input type.

impl<A: Codec> From<&SeqSlice<A>> for String

fn from(seq: &SeqSlice<A>) -> Self

Converts to this type from the input type.

impl<A: Codec> From<&SeqSlice<A>> for u8

fn from(slice: &SeqSlice<A>) -> u8

Converts to this type from the input type.

impl<A: Codec> From<&SeqSlice<A>> for usize

fn from(slice: &SeqSlice<A>) -> usize

Converts to this type from the input type.

impl<'a, A: Codec> FromIterator<&'a SeqSlice<A>> for Vec<Seq<A>>

fn from_iter<T: IntoIterator<Item = &'a SeqSlice<A>>>(iter: T) -> Self

Creates a value from an iterator.

impl<A: Codec> Hash for SeqSlice<A>

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

Feeds this value into the given Hasher.

impl<A: Codec> Index<Range<usize>> for SeqSlice<A>

type Output = SeqSlice<A>

The returned type after indexing.

fn index(&self, range: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: Codec> Index<RangeFrom<usize>> for SeqSlice<A>

type Output = SeqSlice<A>

The returned type after indexing.

fn index(&self, range: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: Codec> Index<RangeFull> for SeqSlice<A>

type Output = SeqSlice<A>

The returned type after indexing.

fn index(&self, _range: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: Codec> Index<RangeInclusive<usize>> for SeqSlice<A>

type Output = SeqSlice<A>

The returned type after indexing.

fn index(&self, range: RangeInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: Codec> Index<RangeTo<usize>> for SeqSlice<A>

type Output = SeqSlice<A>

The returned type after indexing.

fn index(&self, range: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: Codec> Index<RangeToInclusive<usize>> for SeqSlice<A>

type Output = SeqSlice<A>

The returned type after indexing.

fn index(&self, range: RangeToInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: Codec> Index<usize> for SeqSlice<A>

type Output = SeqSlice<A>

The returned type after indexing.

fn index(&self, i: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, A: Codec> IntoIterator for &'a SeqSlice<A>

type Item = A

The type of the elements being iterated over.

type IntoIter = SeqIter<'a, A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<A: Ord + Codec> Ord for SeqSlice<A>

fn cmp(&self, other: &SeqSlice<A>) -> Ordering

This method returns an Ordering between self and other.

impl<A: Codec> PartialEq<&Seq<A>> for SeqSlice<A>

fn eq(&self, other: &&Seq<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<A: Codec> PartialEq<&SeqSlice<A>> for Seq<A>

fn eq(&self, other: &&SeqSlice<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<A: Codec> PartialEq<&SeqSlice<A>> for SeqSlice<A>

fn eq(&self, other: &&SeqSlice<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<A: Codec> PartialEq<Seq<A>> for &SeqSlice<A>

fn eq(&self, other: &Seq<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<A: Codec> PartialEq<Seq<A>> for SeqSlice<A>

fn eq(&self, other: &Seq<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<A: Codec> PartialEq<SeqSlice<A>> for &SeqSlice<A>

fn eq(&self, other: &SeqSlice<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<A: Codec> PartialEq<SeqSlice<A>> for Seq<A>

fn eq(&self, other: &SeqSlice<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<A: Codec> PartialEq for SeqSlice<A>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<A: PartialOrd + Codec> PartialOrd for SeqSlice<A>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<A: Codec + Complement> ReverseComplement for SeqSlice<A>

type Output = Seq<A>

fn revcomp(&self) -> Seq<A>

Reverse complement of a sequence

impl<A: Codec> ToOwned for SeqSlice<A>

Clone a borrowed slice of a sequence into an owned version.

use bio_seq::prelude::*;

let seq = dna!("CATCGATCGATCG");
let slice = &seq[2..7]; // TCGAT
let owned = slice.to_owned();

assert_eq!(&owned, &seq[2..7]);

type Owned = Seq<A>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<A: Eq + Codec> Eq for SeqSlice<A>