Enum bam::record::cigar::Operation

pub enum Operation {
    AlnMatch,
    Insertion,
    Deletion,
    Skip,
    Soft,
    Hard,
    Padding,
    SeqMatch,
    SeqMismatch,
}

Cigar operation.

Variants

AlnMatch

Insertion

Deletion

Skip

Soft

Hard

Padding

SeqMatch

SeqMismatch

Implementations

impl Operation

pub fn from_symbol(symbol: u8) -> Result<Operation, String>

Convert u8 symbol (for example b'M') into Operation.

To convert a number 0-8 into Operation use Operation::from(number).

pub fn to_byte(self) -> u8

Convert Operation into u8 symbol (for example b'M').

To convert Operation into a number 0-8 use operation as u8.

pub fn consumes_query(self) -> bool

Checks if the operation consumes query. For example, M consumes query, while D does not.

pub fn consumes_ref(self) -> bool

Checks if the operation consumes reference. For example, M consumes reference, while I does not.

pub fn class(self) -> Class

Returns operation class: operations combined by their behavior (soft and insertion both consume query but not reference, so they represent the same class Insertion).

pub fn is_match(self) -> bool

Returns true if the operation consumes both query and reference (M, = or X).

pub fn is_insertion(self) -> bool

Returns true if the operation consumes only reference (I or S).

pub fn is_deletion(self) -> bool

Returns true if the operation consumes only query (D or N).

pub fn is_hard_clipping(self) -> bool

Returns true if the operation does not consume query nor reference (H or P).

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Operation

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

Formats the value using the given formatter.

impl Display for Operation

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

Formats the value using the given formatter.

impl From<u32> for Operation

fn from(value: u32) -> Operation

Performs the conversion.

impl PartialEq<Operation> for Operation

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

impl Eq for Operation

impl StructuralEq for Operation

impl StructuralPartialEq for Operation