Struct noodles_sam::header::program::Program

source · [−]

pub struct Program { /* private fields */ }

Expand description

A SAM header program.

A program describes any program that created, viewed, or mutated a SAM file. The program ID is guaranteed to be set.

Implementations

source

impl Program

source

pub fn builder() -> Builder

Creates a SAM header program builder.

Examples

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

source

pub fn new(id: I) -> Self where
I: Into<String>,

Creates a program with an ID.

Examples

use noodles_sam::header::Program;
let program = Program::new("pg0");
assert_eq!(program.id(), "pg0");

source

pub fn id(&self) -> &str

Returns the program ID.

Examples

use noodles_sam::header::Program;
let program = Program::new("pg0");
assert_eq!(program.id(), "pg0");

source

pub fn id_mut(&mut self) -> &mut String

Returns a mutable reference to the program ID.

Examples

use noodles_sam::header::Program;

let mut program = Program::new("pg0");
assert_eq!(program.id(), "pg0");

*program.id_mut() = String::from("pg1");
assert_eq!(program.id(), "pg1");

source

pub fn name(&self) -> Option<&str>

Returns the program name.

Examples

use noodles_sam::header::Program;
let program = Program::new("pg0");
assert!(program.name().is_none());

source

pub fn command_line(&self) -> Option<&str>

Returns the command line.

Examples

use noodles_sam::header::Program;
let program = Program::new("pg0");
assert!(program.command_line().is_none());

source

pub fn previous_id(&self) -> Option<&str>

Returns the previous program ID.

Examples

use noodles_sam::header::Program;
let program = Program::new("pg0");
assert!(program.previous_id().is_none());

source

pub fn description(&self) -> Option<&str>

Returns the description.

Examples

use noodles_sam::header::Program;
let program = Program::new("pg0");
assert!(program.description().is_none());

source

pub fn version(&self) -> Option<&str>

Returns the program version.

Examples

use noodles_sam::header::Program;
let program = Program::new("pg0");
assert!(program.version().is_none());

source

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

Returns the raw fields of the program.

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

Examples

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

let zn = Tag::Other([b'z', b'n']);

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

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

assert_eq!(fields.get(&Tag::Id), None);
assert_eq!(program.id(), "pg0");