Struct bam::header::HeaderEntry

pub struct HeaderEntry { /* fields omitted */ }

A single header line.

You can create a new entry using header_line, ref_sequence and so on. After that you can modify line tags using push, remove and others.

However, be careful not to delete the required tag, as well as check the required tag format.

Implementations

impl HeaderEntry

pub fn header_line(version: String) -> HeaderEntry

Creates a new @HD header entry.

pub fn ref_sequence(seq_name: String, seq_len: u32) -> HeaderEntry

Creates a new @SQ header entry.

pub fn read_group(ident: String) -> HeaderEntry

Creates a new @RG header entry.

pub fn program(ident: String) -> HeaderEntry

Creates a new @PG header entry.

pub fn entry_type(&self) -> EntryType

pub fn entry_name(&self) -> &'static TagName

Returns record two-letter name of the line (such as HD or SQ).

pub fn iter(&self) -> Iter<'_, Tag>

Returns an iterator over all tags.

pub fn get(&self, name: &TagName) -> Option<&str>

Returns a tag with name if present. Takes O(n_tags).

pub fn get_mut(&mut self, name: &TagName) -> Option<&mut String>

Returns a mutable tag with name if present. Takes O(n_tags).

pub fn push(&mut self, name: &TagName, value: String) -> &mut Self

Pushes a tag to the end. Takes O(1).

pub fn insert(&mut self, name: &TagName, value: String) -> Option<String>

Replaces tag value if present and returns previous value. If there is no tag with the same name, pushes the new tag to the end. Takes O(n_tags).

pub fn remove(&mut self, name: &TagName) -> Option<String>

Removes the tag, if present, and returns its value. Takes O(n_tags).

pub fn len(&self) -> usize

Returns the number of tags in the line.

pub fn write<W: Write>(&self, writer: &mut W) -> Result<()>

Write the whole entry in a line.

pub fn parse_line(line: &str) -> Result<Self>

Trait Implementations

impl Clone for HeaderEntry

fn clone(&self) -> HeaderEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderEntry

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

Formats the value using the given formatter.