Struct noodles_sam::header::header::Builder

pub struct Builder { /* private fields */ }

A SAM header header builder.

Implementations

impl Builder

pub fn set_version(self, version: Version) -> Self

Sets a format version.

Examples

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

pub fn set_sort_order(self, sort_order: SortOrder) -> Self

Sets a sort order.

Examples

use noodles_sam::header::header::{Header, SortOrder};
let header = Header::builder().set_sort_order(SortOrder::Coordinate).build();
assert_eq!(header.sort_order(), Some(SortOrder::Coordinate));

pub fn set_group_order(self, group_order: GroupOrder) -> Self

Sets a group order.

Examples

use noodles_sam::header::header::{GroupOrder, Header};
let header = Header::builder().set_group_order(GroupOrder::Reference).build();
assert_eq!(header.group_order(), Some(GroupOrder::Reference));

pub fn set_subsort_order(self, subsort_order: SubsortOrder) -> Self

Sets a subsort order.

Examples

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

let header = Header::builder()
    .set_subsort_order(SubsortOrder::Coordinate(vec![String::from("MI")]))
    .build();

assert_eq!(header.subsort_order(), Some(&SubsortOrder::Coordinate(vec![String::from("MI")])));

pub fn insert<I>(self, tag: Tag, value: I) -> Self where
    I: Into<String>, 

Inserts a tag-raw value pair.

Examples

use noodles_sam::header::header::{Header, Tag};
let zn = Tag::Other([b'z', b'n']);
let header = Header::builder().insert(zn, "noodles").build();
assert_eq!(header.fields().get(&zn), Some(&String::from("noodles")));

pub fn build(self) -> Header

Builds a header header.

Examples

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

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.