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>

Implementations

impl Header

pub fn new() -> Self

Create a new (empty) Header.

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

Create a new Header using the given HeaderView as the template.

After construction, you can modify the header independently from the template header.

Arguments

• header - The HeaderView to use as the template.

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

Create a new Header using the given HeaderView as as template, but subsetting to the given samples.

Arguments

• header - The HeaderView to use for the template.
• samples - A slice of byte-encoded ([u8]) sample names.

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

Add a sample to the header.

Arguments

• sample - Name of the sample to add (to the end of the sample list).

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

Add a record to the header.

Arguments

• record - String representation of the header line

Example

header.push_record(format!("##contig=<ID={},length={}>", "chrX", 155270560).as_bytes());

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

Remove a FILTER entry from the header.

Arguments

• tag - Name of the FLT tag to remove.

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

Remove an INFO entry from the header.

Arguments

• tag - Name of the INFO tag to remove.

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

Remove a FORMAT entry from the header.

Arguments

• tag - Name of the FORMAT tag to remove.

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

Remove a contig entry from the header.

Arguments

• tag - Name of the FORMAT tag to remove.

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

Remove a structured entry from the header.

Arguments

• tag - Name of the structured tag to remove.

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

Remove a generic entry from the header.

Arguments

• tag - Name of the generic tag to remove.

Trait Implementations

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Header

fn drop(&mut self)

Executes the destructor for this type.