Struct ReadSegment

pub struct ReadSegment {
    pub length: Option<usize>,
    pub kind: SegmentType,
    /* private fields */
}

The read segment describing a given kind (SegmentType), optional length, and offset of the bases within a crate::read_structure::ReadStructure.

Fields

length: Option<usize>

The optional length of this segment

kind: SegmentType

The segment type

Implementations

impl ReadSegment

pub fn extract_bases<'a, B>( &self, bases: &'a [B], ) -> Result<&'a [B], ReadStructureError>

Extract the bases corresponding to this ReadSegment from a slice.

Errors

• If the segment does not fall wholely within the slice.

pub fn extract_bases_and_quals<'a, B, Q>( &self, bases: &'a [B], quals: &'a [Q], ) -> Result<(&'a [B], &'a [Q]), ReadStructureError>

Extract the bases and corresponding quals to this ReadSegment from a slice.

Errors

• If the segment does not fall wholely within the slice.
• If the bases and quals lengths are not equal.

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

Returns the length of the read segment.

pub fn has_length(&self) -> bool

Returns true if the read segment has a length defined (i.e. not None)

Trait Implementations

impl Clone for ReadSegment

fn clone(&self) -> ReadSegment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadSegment

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

Formats the value using the given formatter.

impl Display for ReadSegment

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

Formats the ReadSegment as a string.

impl FromStr for ReadSegment

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

Builds a ReadSegment from a string representation. The character representation of SegmentType must be the last character, while the leading character(s) either a non-zero integer, or the any-length character.

Errors

Returns Err if the string was too short, if the length could not be parsed, or if the segment type could not be recognized.

type Err = ReadStructureError

The associated error which can be returned from parsing.

impl PartialEq for ReadSegment

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

impl StructuralPartialEq for ReadSegment