Struct rust_htslib::bam::record::CigarStringView

pub struct CigarStringView { /* fields omitted */ }

Methods

impl CigarStringView

pub fn new(c: CigarString, pos: i32) -> CigarStringView

Construct a new CigarStringView from a CigarString at a position

pub fn end_pos(&self) -> Result<i32, CigarError>

Get (exclusive) end position of alignment.

pub fn read_pos(
    &self,
    ref_pos: u32,
    include_softclips: bool,
    include_dels: bool
) -> Result<Option<u32>, CigarError>

For a given position in the reference, get corresponding position within read. If reference position is outside of the read alignment, return None.

Arguments

• ref_pos - the reference position
• include_softclips - if true, softclips will be considered as matches or mismatches
• include_dels - if true, positions within deletions will be considered (first reference matching read position after deletion will be returned)

impl<'a> CigarStringView

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;

pub fn iter(&'a self) -> Iter<'a, Cigar>

Methods from Deref<Target = CigarString>

pub fn to_string(&self) -> String

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;

pub fn iter(&'a self) -> Iter<'a, Cigar>

Trait Implementations

impl Eq for CigarStringView

impl PartialEq for CigarStringView

fn eq(&self, __arg_0: &CigarStringView) -> bool

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

fn ne(&self, __arg_0: &CigarStringView) -> bool

This method tests for !=.

impl Clone for CigarStringView

fn clone(&self) -> CigarStringView

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CigarStringView

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Deref for CigarStringView

type Target = CigarString

The resulting type after dereferencing.

fn deref(&self) -> &CigarString

Dereferences the value.

impl Index<usize> for CigarStringView

type Output = Cigar

The returned type after indexing.

fn index(&self, index: usize) -> &Cigar

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for CigarStringView

fn index_mut(&mut self, index: usize) -> &mut Cigar

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a CigarStringView

type Item = &'a Cigar

The type of the elements being iterated over.

type IntoIter = Iter<'a, Cigar>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Display for CigarStringView

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

Formats the value using the given formatter.