Struct noodles::csi::binning_index::index::header::Builder

pub struct Builder { /* private fields */ }

A tabix index header builder.

Implementations

impl Builder

pub fn bed() -> Builder

Creates a builder that targets the BED format.

Examples

use noodles_csi::binning_index::index::header::Builder;
let builder = Builder::bed();

pub fn gff() -> Builder

Creates a builder that targets the GFF format.

Examples

use noodles_csi::binning_index::index::header::Builder;
let builder = Builder::gff();

pub fn sam() -> Builder

Creates a builder that targets the SAM format.

Examples

use noodles_csi::binning_index::index::header::Builder;
let builder = Builder::sam();

pub fn vcf() -> Builder

Creates a builder that targets the VCF format.

Examples

use noodles_csi::binning_index::index::header::Builder;
let builder = Builder::vcf();

pub fn set_format(self, format: Format) -> Builder

Sets a format.

Examples

use noodles_csi::binning_index::index::{header::Format, Header};
let header = Header::builder().set_format(Format::Vcf).build();
assert_eq!(header.format(), Format::Vcf);

pub fn set_reference_sequence_name_index( self, reference_sequence_name_index: usize ) -> Builder

Sets a reference sequence name index.

Examples

use noodles_csi::binning_index::index::Header;
let header = Header::builder().set_reference_sequence_name_index(0).build();
assert_eq!(header.reference_sequence_name_index(), 0);

pub fn set_start_position_index(self, start_position_index: usize) -> Builder

Sets a start position index.

Examples

use noodles_csi::binning_index::index::Header;
let header = Header::builder().set_start_position_index(3).build();
assert_eq!(header.start_position_index(), 3);

pub fn set_end_position_index( self, end_position_index: Option<usize> ) -> Builder

Sets an end position index.

Examples

use noodles_csi::binning_index::index::Header;
let header = Header::builder().set_end_position_index(Some(4)).build();
assert_eq!(header.end_position_index(), Some(4));

pub fn set_line_comment_prefix(self, line_comment_prefix: u8) -> Builder

Sets a line comment prefix.

Examples

use noodles_csi::binning_index::index::Header;
let header = Header::builder().set_line_comment_prefix(b'#').build();
assert_eq!(header.line_comment_prefix(), b'#');

pub fn set_line_skip_count(self, line_skip_count: u32) -> Builder

Sets a line skip count.

Examples

use noodles_csi::binning_index::index::Header;
let header = Header::builder().set_line_skip_count(0).build();
assert_eq!(header.line_skip_count(), 0);

pub fn set_reference_sequence_names( self, reference_sequence_names: IndexSet<String> ) -> Builder

Sets reference sequence names.

Examples

use noodles_csi::binning_index::index::{header::ReferenceSequenceNames, Header};

let reference_sequence_names = ReferenceSequenceNames::new();

let header = Header::builder()
    .set_reference_sequence_names(reference_sequence_names.clone())
    .build();

assert_eq!(header.reference_sequence_names(), &reference_sequence_names);

pub fn build(self) -> Header

Builds a tabix index header.

Examples

use noodles_csi::binning_index::index::Header;
let index = Header::builder().build();

Trait Implementations

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.