Struct noodles::sam::header::header::Header

pub struct Header { /* fields omitted */ }

A SAM header header.

The header describes file-level metadata. The format version is guaranteed to be set.

Implementations

impl Header

pub fn builder() -> Builder

Creates a SAM header header builder.

Examples

use noodles_sam::header::header::Header;
let builder = Header::builder();

pub fn new(version: Version) -> Header

Creates a header with a format version.

Examples

use noodles_sam::header::header::{Header, Version};
let header = Header::new(Version::new(1, 6));
assert_eq!(header.version(), Version::new(1, 6));

pub fn version(&self) -> Version

Returns the format version.

Examples

use noodles_sam::header::header::{Header, Version};
let header = Header::new(Version::new(1, 6));
assert_eq!(header.version(), Version::new(1, 6));

pub fn version_mut(&mut self) -> &mut Version

Returns a mutable reference to the format version.

Examples

use noodles_sam::header::header::{Header, Version};

let mut header = Header::new(Version::new(1, 6));
assert_eq!(header.version(), Version::new(1, 6));

*header.version_mut() = Version::new(1, 5);
assert_eq!(header.version(), Version::new(1, 5));

pub fn sort_order(&self) -> Option<SortOrder>

Returns the sort order.

Examples

use noodles_sam::header::header::Header;
let header = Header::default();
assert!(header.sort_order().is_none());

pub fn group_order(&self) -> Option<GroupOrder>

Returns the group order.

Examples

use noodles_sam::header::header::Header;
let header = Header::default();
assert!(header.group_order().is_none());

pub fn subsort_order(&self) -> Option<&SubsortOrder>

Returns the subsort order.

Examples

use noodles_sam::header::header::Header;
let header = Header::default();
assert!(header.subsort_order().is_none());

pub fn fields(&self) -> &HashMap<Tag, String, RandomState>

Returns the raw fields of the header.

This includes any field that is not specially handled by the structure itself. For example, this will not include the version field, as it is parsed and available as Self::version.

Examples

use noodles_sam::header::header::{Header, SortOrder, Tag, Version};

let header = Header::builder()
    .set_version(Version::new(1, 6))
    .insert(Tag::Other(String::from("zn")), String::from("noodles"))
    .build();

let fields = header.fields();
assert_eq!(fields.len(), 1);
assert_eq!(
    fields.get(&Tag::Other(String::from("zn"))),
    Some(&String::from("noodles"))
);

assert_eq!(fields.get(&Tag::Version), None);
assert_eq!(header.version(), Version::new(1, 6));

Trait Implementations

impl Clone for Header

pub fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

pub fn default() -> Header

Returns the “default value” for a type.

impl Display for Header

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

Formats the value using the given formatter.

impl PartialEq<Header> for Header

pub fn eq(&self, other: &Header) -> bool

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

pub fn ne(&self, other: &Header) -> bool

This method tests for !=.

impl TryFrom<Record> for Header

type Error = TryFromRecordError

The type returned in the event of a conversion error.

pub fn try_from(
    record: Record
) -> Result<Header, <Header as TryFrom<Record>>::Error>

Performs the conversion.

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header