Struct rust_htslib::bcf::header::Header

pub struct Header {
    pub inner: *mut bcf_hdr_t,
    pub subset: Option<SampleSubset>,
}

A BCF header.

Fields

inner: *mut bcf_hdr_t

subset: Option<SampleSubset>

Methods

impl Header

pub fn new() -> Self

Create a new header.

pub fn with_template(header: &HeaderView) -> Self

pub fn subset_template(
    header: &HeaderView,
    samples: &[&[u8]]
) -> Result<Self, SubsetError>

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn push_sample(&mut self, sample: &[u8]) -> &mut Self

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn push_record(&mut self, record: &[u8]) -> &mut Self

Add a record to the header.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn remove_info(&mut self, tag: &[u8]) -> &mut Self

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn remove_format(&mut self, tag: &[u8]) -> &mut Self

Trait Implementations

impl Debug for Header

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

Formats the value using the given formatter.

impl Drop for Header

fn drop(&mut self)

Executes the destructor for this type.