Struct noodles::sam::record::cigar::op::Op

pub struct Op { /* fields omitted */ }

A SAM record CIGAR operation.

Implementations

impl Op

pub fn new(kind: Kind, len: u32) -> Op

Creates a CIGAR operation.

Examples

use noodles_sam::record::cigar::{op::Kind, Op};

let op = Op::new(Kind::Match, 13);

assert_eq!(op.kind(), Kind::Match);
assert_eq!(op.len(), 13);

pub fn kind(self) -> Kind

Returns the kind of the operation.

Examples

use noodles_sam::record::cigar::{op::Kind, Op};
let op = Op::new(Kind::Match, 13);
assert_eq!(op.kind(), Kind::Match);

pub fn len(self) -> u32

Returns the length of the operation.

Examples

use noodles_sam::record::cigar::{op::Kind, Op};
let op = Op::new(Kind::Match, 13);
assert_eq!(op.len(), 13);

pub fn is_empty(self) -> bool

Returns whether the operation is a no-op.

That is, whether the operation has a length of 0.

Examples

use noodles_sam::record::cigar::{op::Kind, Op};

let op = Op::new(Kind::Match, 0);
assert!(op.is_empty());

let op = Op::new(Kind::Match, 13);
assert!(!op.is_empty());

Trait Implementations

impl Clone for Op

pub fn clone(&self) -> Op

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Op

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

Formats the value using the given formatter.

impl Display for Op

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

Formats the value using the given formatter.

impl FromStr for Op

type Err = ParseError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Op, <Op as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq<Op> for Op

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for Op

impl Eq for Op

impl StructuralEq for Op

impl StructuralPartialEq for Op