Struct Builder

pub struct Builder<I>
where
    I: Inner,
{ /* private fields */ }

A SAM header record map value builder.

Implementations

impl<I> Builder<I>

where I: Inner,

pub fn insert<V>(self, key: Other<I::StandardTag>, value: V) -> Self

where V: Into<BString>,

Inserts a key-value pair into the other fields.

Examples

use bstr::BString;
use noodles_sam::header::record::value::{map::{Header, Tag}, Map};

let nd = match Tag::try_from([b'n', b'd']) {
    Ok(Tag::Other(tag)) => tag,
    _ => unreachable!(),
};

let header = Map::<Header>::builder().insert(nd, "noodles").build()?;

assert_eq!(header.other_fields().get(b"nd"), Some(&BString::from("noodles")));

pub fn build(self) -> Result<Map<I>, BuildError>

Builds a SAM header record map value.

Examples

use noodles_sam::header::record::value::{map::Header, Map};
let header = Map::<Header>::builder().build()?;

impl Builder<Header>

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

Sets a format version.

Examples

use noodles_sam::header::record::value::{
    map::{self, header::Version},
    Map,
};

let version = Version::new(1, 6);
let header = Map::<map::Header>::builder().set_version(version).build()?;
assert_eq!(header.version(), version);

impl Builder<ReferenceSequence>

pub fn set_length(self, length: NonZeroUsize) -> Self

Sets a reference sequence length.

Examples

use std::num::NonZeroUsize;

use noodles_sam::header::record::value::{map::ReferenceSequence, Map};

let length = NonZeroUsize::try_from(13)?;

let reference_sequence = Map::<ReferenceSequence>::builder()
    .set_length(length)
    .build()?;

assert_eq!(reference_sequence.length(), length);

Trait Implementations

impl<I> Default for Builder<I>

where I: Inner,

fn default() -> Self

Returns the “default value” for a type.