Struct bam_builder::ReadPairSpecBuilder

pub struct ReadPairSpecBuilder { /* fields omitted */ }

Builder for ReadPairSpec.

Implementations

impl ReadPairSpecBuilder

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

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

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

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

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

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

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

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

pub fn quals2(&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 start1(&mut self, value: i64) -> &mut Self

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

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

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

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

true if unmapped, defaults to true.

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

true if unmapped, defaults to true.

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

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

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

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

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

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

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

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

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

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

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

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

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

Tags for the reads, mate tags will be filled in by default.

pub fn build(&self) -> Result<ReadPairSpec, String>

Builds a new ReadPairSpec.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ReadPairSpecBuilder

pub fn clone(&self) -> ReadPairSpecBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ReadPairSpecBuilder

pub fn default() -> ReadPairSpecBuilder

Returns the "default value" for a type.