Struct Cigar

pub struct Cigar<'a>(/* private fields */);

Raw SAM record CIGAR operations.

Implementations

impl<'a> Cigar<'a>

pub fn new(src: &'a [u8]) -> Self

Creates SAM record CIGAR operations.

Examples

use noodles_sam::record::Cigar;
let cigar = Cigar::new(b"8M13N");

pub fn is_empty(&self) -> bool

Returns whether there are any CIGAR operations.

Examples

use noodles_sam::record::Cigar;

let cigar = Cigar::new(b"");
assert!(cigar.is_empty());

let cigar = Cigar::new(b"8M13N");
assert!(!cigar.is_empty());

pub fn iter(&self) -> impl Iterator<Item = Result<Op, ParseError>> + '_

Returns an iterator over CIGAR operations.

Examples

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

let cigar = Cigar::new(b"");
assert!(cigar.iter().next().is_none());

let cigar = Cigar::new(b"8M13N");
let mut iter = cigar.iter();
assert_eq!(iter.next().transpose()?, Some(Op::new(Kind::Match, 8)));
assert_eq!(iter.next().transpose()?, Some(Op::new(Kind::Skip, 13)));
assert!(iter.next().is_none());

Trait Implementations

impl<'a> AsRef<[u8]> for Cigar<'a>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Cigar for Cigar<'a>

fn is_empty(&self) -> bool

Returns whether there are any operations.

fn len(&self) -> usize

Returns the number of operations.

fn iter(&self) -> Box<dyn Iterator<Item = Result<Op>> + '_>

Returns an iterator over operations.

fn alignment_span(&self) -> Result<usize>

Calculates the alignment span over the reference sequence.

fn read_length(&self) -> Result<usize>

Calculates the read length.

impl<'a> Debug for Cigar<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Cigar<'a>

fn eq(&self, other: &Cigar<'a>) -> 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<'a> TryFrom<Cigar<'a>> for Cigar

type Error = Error

The type returned in the event of a conversion error.

fn try_from(Cigar: Cigar<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Eq for Cigar<'a>

impl<'a> StructuralPartialEq for Cigar<'a>