noodles_cram::record::feature

Enum Feature

Source
pub enum Feature {
    Bases {
        position: Position,
        bases: Vec<u8>,
    },
    Scores {
        position: Position,
        quality_scores: Vec<u8>,
    },
    ReadBase {
        position: Position,
        base: u8,
        quality_score: u8,
    },
    Substitution {
        position: Position,
        value: Value,
    },
    Insertion {
        position: Position,
        bases: Vec<u8>,
    },
    Deletion {
        position: Position,
        len: usize,
    },
    InsertBase {
        position: Position,
        base: u8,
    },
    QualityScore {
        position: Position,
        quality_score: u8,
    },
    ReferenceSkip {
        position: Position,
        len: usize,
    },
    SoftClip {
        position: Position,
        bases: Vec<u8>,
    },
    Padding {
        position: Position,
        len: usize,
    },
    HardClip {
        position: Position,
        len: usize,
    },
}
Expand description

A CRAM record feature.

Variants§

§

Bases

A stretch of bases.

Fields

§position: Position
§bases: Vec<u8>
§

Scores

A stretch of quality scores.

Fields

§position: Position
§quality_scores: Vec<u8>
§

ReadBase

A base-quality score pair.

Fields

§position: Position
§base: u8
§quality_score: u8
§

Substitution

A base substitution.

Fields

§position: Position
§value: Value
§

Insertion

Inserted bases.

Fields

§position: Position
§bases: Vec<u8>
§

Deletion

A number of deleted bases.

Fields

§position: Position
§len: usize
§

InsertBase

A single inserted base.

Fields

§position: Position
§base: u8
§

QualityScore

A single quality score.

Fields

§position: Position
§quality_score: u8
§

ReferenceSkip

A number of skipped bases.

Fields

§position: Position
§len: usize
§

SoftClip

Soft clipped bases.

Fields

§position: Position
§bases: Vec<u8>
§

Padding

A number of padded bases.

Fields

§position: Position
§len: usize
§

HardClip

A number of hard clipped bases.

Fields

§position: Position
§len: usize

Implementations§

Source§

impl Feature

Source

pub fn code(&self) -> Code

Returns the feature code.

§Examples
use noodles_core::Position;
use noodles_cram::record::{feature::Code, Feature};

let position = Position::try_from(8)?;
let feature = Feature::Padding{ position, len: 13 };

assert_eq!(feature.code(), Code::Padding);
Source

pub fn position(&self) -> Position

Returns the feature position.

§Examples
use noodles_core::Position;
use noodles_cram::record::Feature;

let position = Position::try_from(8)?;
let feature = Feature::Padding{ position, len: 13 };

assert_eq!(feature.position(), position);

Trait Implementations§

Source§

impl Clone for Feature

Source§

fn clone(&self) -> Feature

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 Feature

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Feature

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Feature

Source§

impl StructuralPartialEq for Feature

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.