Struct ReadSegment 

pub struct ReadSegment {
    pub length: Option<usize>,
    pub kind: SegmentType,
}

A single segment of a read structure: a segment type and an optional fixed length.

Segments are typically obtained by parsing a ReadStructure; the positions of the segment’s bases within a read are tracked by the enclosing ReadStructure, not here.

Fields

length: Option<usize>

The optional length of this segment. None means this is the indefinite-length (+) segment; its concrete span is resolved by the enclosing ReadStructure at extract time (it runs from just after the preceding segments up to just before the following segments, so in 8B+M10T the +M segment covers everything between byte 8 and read_len - 10). At most one segment per read structure may be indefinite.

kind: SegmentType

The segment type.

Implementations

impl ReadSegment

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

Returns the length of the read segment, or None for an indefinite-length (+) segment.

pub fn has_length(&self) -> bool

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

Trait Implementations

impl Clone for ReadSegment

fn clone(&self) -> ReadSegment

Returns a duplicate of the value.

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 Hash for ReadSegment

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ReadSegment

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

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

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 Eq for ReadSegment

impl StructuralPartialEq for ReadSegment