Enum read_structure::SegmentType

#[non_exhaustive]
#[repr(u8)]
pub enum SegmentType {
    Template,
    SampleBarcode,
    MolecularBarcode,
    Skip,
}

The SegmentType type. See the module level documentation for more.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Template

Template: the bases in the segment are reads of template (e.g. genomic dna, rna, etc.)

SampleBarcode

Sample Barcode: the bases in the segment are an index sequence used to identify the sample being sequenced

MolecularBarcode

Molecular Barcode: the bases in the segment are an index sequence used to identify the unique source molecule being sequence (i.e. a UMI)

Skip

Skip: the bases in the segment should be skipped or ignored, for example if they are monotemplate sequence generated by the library preparation

Implementations

impl SegmentType

pub fn value(&self) -> char

Returns the character representation of this segment type.

Trait Implementations

impl Clone for SegmentType

fn clone(&self) -> SegmentType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SegmentType

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

Formats the value using the given formatter.

impl Hash for SegmentType

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for SegmentType

type Iterator = SegmentTypeIter

fn iter() -> SegmentTypeIter

impl Ord for SegmentType

fn cmp(&self, other: &SegmentType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<SegmentType> for SegmentType

fn eq(&self, other: &SegmentType) -> 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 !=.

impl PartialOrd<SegmentType> for SegmentType

fn partial_cmp(&self, other: &SegmentType) -> 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 TryFrom<char> for SegmentType

fn try_from(value: char) -> Result<Self, Self::Error>

Returns the segment type given the character representation.

Errors

• If SegmentType not valid

type Error = ReadStructureError

The type returned in the event of a conversion error.

impl TryFrom<u8> for SegmentType

fn try_from(value: u8) -> Result<Self, Self::Error>

Returns the segment type given the byte representation.

Errors

• If SegmentType not valid

type Error = ReadStructureError

The type returned in the event of a conversion error.

impl Copy for SegmentType

impl Eq for SegmentType

impl StructuralEq for SegmentType

impl StructuralPartialEq for SegmentType