Struct bam_builder::ReadFragSpecBuilder

pub struct ReadFragSpecBuilder { /* private fields */ }

Builder for ReadFragSpec.

Implementations

impl ReadFragSpecBuilder

pub fn name(&mut self, value: String) -> &mut Self

Name of the read, will be filled in by BamBuilder::next_name by default.

pub fn bases(&mut self, value: String) -> &mut Self

Sequence bases, will be filled in by BamBuilder::random_bases by default.

pub fn quals(&mut self, value: String) -> &mut Self

Quality string, will be based on the BamBuilder::base_quality by default.

pub fn contig(&mut self, value: i32) -> &mut Self

Reference contig if mapped, defaults to unmapped.

pub fn start(&mut self, value: i64) -> &mut Self

0-based location on reference contig if mapped. defaults to unmapped.

pub fn unmapped(&mut self, value: bool) -> &mut Self

true if unmapped, defaults to true.

pub fn cigar(&mut self, value: String) -> &mut Self

Alignment, defaults to all M if mapped or * if unmapped.

pub fn mapq(&mut self, value: u8) -> &mut Self

map quality of the read, defaults to 60 if mapped, * if unmapped.

pub fn strand(&mut self, value: Strand) -> &mut Self

Strand the read maps to, defaults to wrappers::Strand::Plus.

pub fn attrs(&mut self, value: HashMap<String, AuxType>) -> &mut Self

Tags for the read, defaults to none.

pub fn build(&self) -> Result<ReadFragSpec, ReadFragSpecBuilderError>

Builds a new ReadFragSpec.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ReadFragSpecBuilder

fn clone(&self) -> ReadFragSpecBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ReadFragSpecBuilder

fn default() -> Self

Returns the “default value” for a type.