Struct rust_htslib::bcf::header::HeaderView

pub struct HeaderView {
    pub inner: *mut bcf_hdr_t,
}

Fields

inner: *mut bcf_hdr_t

Methods

impl HeaderView

pub fn new(inner: *mut bcf_hdr_t) -> Self

pub fn sample_count(&self) -> u32

pub fn samples(&self) -> Vec<&[u8]>

Get vector of sample names defined in the header.

pub fn sample_id(&self, sample: &[u8]) -> Option<usize>

Obtain id (column index) of given sample. Returns None if sample is not present in header.

pub fn rid2name(&self, rid: u32) -> &[u8]

pub fn name2rid(&self, name: &[u8]) -> Result<u32, RidError>

pub fn info_type(
    &self,
    tag: &[u8]
) -> Result<(TagType, TagLength), TagTypeError>

pub fn format_type(
    &self,
    tag: &[u8]
) -> Result<(TagType, TagLength), TagTypeError>

pub fn name_to_id(&self, id: &[u8]) -> Result<Id, IdError>

Convert string ID (e.g., for a FILTER value) to its numeric identifier.

pub fn id_to_name(&self, id: Id) -> Vec<u8>

Convert integer representing an identifier (e.g., a FILTER value) to its string name.bam.

pub fn sample_to_id(&self, id: &[u8]) -> Result<Id, SampleError>

Convert string sample name to its numeric identifier.

pub fn id_to_sample(&self, id: Id) -> Vec<u8>

Convert integer representing an contig to its name.

pub fn header_records(&self) -> Vec<HeaderRecord>

Return structured HeaderRecords.

Trait Implementations

impl Drop for HeaderView

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for HeaderView

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderView

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

Formats the value using the given formatter.