Struct ReadStructure

pub struct ReadStructure { /* private fields */ }

The read structure composed of one or more ReadSegments.

Implementations

impl ReadStructure

pub fn new(segments: Vec<ReadSegment>) -> Result<Self, ReadStructureError>

Builds a new ReadStructure from a vector of ReadSegments. The offsets for the ReadSegments are not updated. Builds a new ReadStructure from a vector of ReadSegments.

Errors

Returns Err if the any segment but the last has an indefinite length, or no elements exist.

pub fn has_fixed_length(&self) -> bool

Returns true if the ReadStructure has a fixed (i.e. non-variable) length, false if there are segments but no fixed length.

pub fn fixed_length(&self) -> Option<usize>

Returns the fixed length if there is one.

pub fn number_of_segments(&self) -> usize

Returns the number of segments in this read structure.

pub fn segments(&self) -> &[ReadSegment]

Returns the underlying elements in this read structure.

pub fn iter(&self) -> impl Iterator<Item = &ReadSegment>

Returns an iterator over the read segments

pub fn segments_by_type( &self, kind: SegmentType, ) -> impl Iterator<Item = &ReadSegment>

Returns the ReadSegments in this read structure of the given kind.

pub fn templates(&self) -> impl Iterator<Item = &ReadSegment>

Returns the template ReadSegments in this read structure

pub fn sample_barcodes(&self) -> impl Iterator<Item = &ReadSegment>

Returns the sample barcode ReadSegments in this read structure

pub fn molecular_barcodes(&self) -> impl Iterator<Item = &ReadSegment>

Returns the molecular barcode ReadSegments in this read structure

pub fn skips(&self) -> impl Iterator<Item = &ReadSegment>

Returns the skip ReadSegments in this read structure

pub fn cellular_barcodes(&self) -> impl Iterator<Item = &ReadSegment>

Returns the cellular barcode ReadSegments in this read structure

pub fn first(&self) -> Option<&ReadSegment>

Returns the first ReadSegment in this read structure

pub fn last(&self) -> Option<&ReadSegment>

Returns the last ReadSegment in this read structure

Trait Implementations

impl Clone for ReadStructure

fn clone(&self) -> ReadStructure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadStructure

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

Formats the value using the given formatter.

impl Display for ReadStructure

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

Formats this read structure as a string.

impl FromStr for ReadStructure

fn from_str(rs: &str) -> Result<Self, Self::Err>

Returns a new read structure from a string, or Err if parsing failed.

type Err = ReadStructureError

The associated error which can be returned from parsing.

impl Index<usize> for ReadStructure

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

Returns the ReadSegment at the given index in the read structure.

type Output = ReadSegment

The returned type after indexing.

impl IntoIterator for ReadStructure

type Item = ReadSegment

The type of the elements being iterated over.

type IntoIter = IntoIter<<ReadStructure as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ReadStructure

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

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

const 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 TryFrom<&[ReadSegment]> for ReadStructure

fn try_from(elements: &[ReadSegment]) -> Result<Self, Self::Error>

Builds a new read structure from a slice of elements.

type Error = ReadStructureError

The type returned in the event of a conversion error.

impl StructuralPartialEq for ReadStructure