Struct read_structure::ReadStructure

source · [−]

pub struct ReadStructure { /* private fields */ }

Expand description

The read structure composed of one or more ReadSegments.

Implementations

source

impl ReadStructure

source

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.

source

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.

source

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

Returns the fixed length if there is one.

source

pub fn number_of_segments(&self) -> usize

Returns the number of segments in this read structure.

source

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

Returns the underlying elements in this read structure.

source

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

Returns an iterator over the read segments

source

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

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

source

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

Returns the template ReadSegments in this read structure

source

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

Returns the sample barcode ReadSegments in this read structure

source

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

Returns the molecular barcode ReadSegments in this read structure

source

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

Returns the skip ReadSegments in this read structure

source

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

Returns the first ReadSegment in this read structure

source

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

Returns the last ReadSegment in this read structure

Trait Implementations

source

impl Clone for ReadStructure

source

fn clone(&self) -> ReadStructure

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for ReadStructure

source

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

Formats the value using the given formatter. Read more

source

impl Display for ReadStructure

source

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

Formats this read structure as a string.

source

impl FromStr for ReadStructure

source

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.

source

impl Index<usize> for ReadStructure

source

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.

source

impl IntoIterator for ReadStructure

type Item = ReadSegment

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

source

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

source

impl TryFrom<&'_ [ReadSegment ]> for ReadStructure

source

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.

Auto Trait Implementations

impl RefUnwindSafe for ReadStructure

impl Send for ReadStructure

impl Sync for ReadStructure

impl Unpin for ReadStructure

impl UnwindSafe for ReadStructure

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct read_structure::ReadStructure

Implementations

impl ReadStructure

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

Errors

pub fn has_fixed_length(&self) -> bool

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

pub fn number_of_segments(&self) -> usize

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for ReadStructure

fn clone(&self) -> ReadStructure

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

impl Debug for ReadStructure

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

impl Display for ReadStructure

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

impl FromStr for ReadStructure

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

type Err = ReadStructureError

impl Index<usize> for ReadStructure

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

type Output = ReadSegment

impl IntoIterator for ReadStructure

type Item = ReadSegment

type IntoIter = IntoIter<Self::Item>

fn into_iter(self) -> Self::IntoIter

impl TryFrom<&'_ [ReadSegment]> for ReadStructure

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

type Error = ReadStructureError

Auto Trait Implementations

impl RefUnwindSafe for ReadStructure

impl Send for ReadStructure

impl Sync for ReadStructure

impl Unpin for ReadStructure

impl UnwindSafe for ReadStructure

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

impl TryFrom<&'_ [ReadSegment ]> for ReadStructure

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,