Struct rust_htslib::bam::record::CigarString

pub struct CigarString(pub Vec<Cigar>);

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

fn into_view(self, pos: i32) -> CigarStringView

Create a CigarStringView from this CigarString at position pos

impl<'a> CigarString

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

Methods from Deref<Target = Vec<Cigar>>

fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

fn into_boxed_slice(self) -> Box<[T]>

Converts the vector into Box<[T]>.

Note that this will drop any excess capacity. Calling this and converting back to a vector with into_vec is equivalent to calling shrink_to_fit.

Examples

let v = vec![1, 2, 3];

let slice = v.into_boxed_slice();

Any excess capacity is removed:

let mut vec = Vec::with_capacity(10);
vec.extend([1, 2, 3].iter().cloned());

assert_eq!(vec.capacity(), 10);
let slice = vec.into_boxed_slice();
assert_eq!(slice.into_vec().capacity(), 3);

fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl PartialEq for CigarString

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

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

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

This method tests for !=.

impl Eq for CigarString

impl Clone for CigarString

fn clone(&self) -> CigarString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for CigarString

type Target = Vec<Cigar>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for CigarString

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

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

impl From<Vec<Cigar>> for CigarString

fn from(v: Vec<Cigar>) -> Self

Performs the conversion.

impl Debug for CigarString

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a CigarString

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 CigarString

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

Formats the value using the given formatter.