[−]Struct rust_htslib::bam::record::CigarString
A CIGAR string. This type wraps around a Vec<Cigar>
.
Example
use rust_htslib::bam::record::{Cigar, CigarString}; let cigar = CigarString(vec![Cigar::Match(100), Cigar::SoftClip(10)]); // access by index assert_eq!(cigar[0], Cigar::Match(100)); // format into classical string representation assert_eq!(format!("{}", cigar), "100M10S"); // iterate for op in &cigar { println!("{}", op); }
Methods
impl CigarString
[src]
pub fn into_view(self, pos: i32) -> CigarStringView
[src]
Create a CigarStringView
from this CigarString at position pos
pub fn from_alignment(alignment: &Alignment, hard_clip: bool) -> Self
[src]
Calculate the bam cigar from the alignment struct. x is the target string
and y is the reference. hard_clip
controls how unaligned read bases are encoded in the
cigar string. Set to true to use the hard clip (H
) code, or false to use soft clip
(S
) code. See the SAM spec for more details.
pub fn from_bytes(text: &[u8]) -> Result<Self, CigarError>
[src]
Create a CigarString from given bytes.
pub fn from_str(text: &str) -> Result<Self, CigarError>
[src]
Create a CigarString from given str.
pub fn to_string(&self) -> String
[src]
impl<'a> CigarString
[src]
Trait Implementations
impl PartialEq<CigarString> for CigarString
fn eq(&self, other: &CigarString) -> bool
fn ne(&self, other: &CigarString) -> bool
impl Clone for CigarString
fn clone(&self) -> CigarString
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl From<Vec<Cigar>> for CigarString
impl From<CigarString> for Vec<Cigar>
fn from(v: CigarString) -> Self
impl<'a> IntoIterator for &'a CigarString
[src]
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
[src]
impl Eq for CigarString
impl Deref for CigarString
impl Display for CigarString
[src]
impl Debug for CigarString
impl Index<usize> for CigarString
type Output = <Vec<Cigar> as Index<usize>>::Output
The returned type after indexing.
fn index(&self, index: usize) -> &Self::Output
impl IndexMut<usize> for CigarString
impl Hash for CigarString
Auto Trait Implementations
impl Send for CigarString
impl Sync for CigarString
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T> From for T
[src]
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,