Struct noodles::sam::header::program::Builder

pub struct Builder { /* fields omitted */ }

A SAM header program builder.

Implementations

impl Builder

pub fn set_id<I>(self, id: I) -> Builder where
    I: Into<String>, 

Sets a program ID.

Examples

use noodles_sam::header::Program;
let program = Program::builder().set_id("pg0").build()?;
assert_eq!(program.id(), "pg0");

pub fn set_name<I>(self, name: I) -> Builder where
    I: Into<String>, 

Sets a program name.

Examples

use noodles_sam::header::Program;

let program = Program::builder()
    .set_id("pg0")
    .set_name("noodles")
    .build()?;

assert_eq!(program.name(), Some("noodles"));

pub fn set_command_line<I>(self, command_line: I) -> Builder where
    I: Into<String>, 

Sets a command line.

Examples

use noodles_sam::header::Program;

let program = Program::builder()
    .set_id("pg0")
    .set_command_line("cargo run")
    .build()?;

assert_eq!(program.command_line(), Some("cargo run"));

pub fn set_previous_id<I>(self, previous_id: I) -> Builder where
    I: Into<String>, 

Sets a previous program ID.

Examples

use noodles_sam::header::Program;

let program = Program::builder()
    .set_id("pg1")
    .set_previous_id("pg0")
    .build()?;

assert_eq!(program.previous_id(), Some("pg0"));

pub fn set_description<I>(self, description: I) -> Builder where
    I: Into<String>, 

Sets a description.

Examples

use noodles_sam::header::Program;

let program = Program::builder()
    .set_id("pg0")
    .set_description("noodles")
    .build()?;

assert_eq!(program.description(), Some("noodles"));

pub fn set_version<I>(self, version: I) -> Builder where
    I: Into<String>, 

Sets a program version.

Examples

use noodles_sam::header::Program;

let program = Program::builder()
    .set_id("pg0")
    .set_version("0.1.0")
    .build()?;

assert_eq!(program.version(), Some("0.1.0"));

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

Inserts a tag-raw value pair.

Examples

use noodles_sam::header::{program::Tag, Program};

let zn = Tag::Other(String::from("zn"));

let program = Program::builder()
    .set_id("pg0")
    .insert(zn.clone(), String::from("noodles"))
    .build()?;

assert_eq!(program.fields().get(&zn), Some(&String::from("noodles")));

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

Builds a SAM header program.

Examples

use noodles_sam::header::Program;
let program = Program::builder().set_id("rg0").build()?;

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

pub fn default() -> Builder

Returns the “default value” for a type.