Struct Header

pub struct Header { /* private fields */ }

A tabix index header.

Implementations

impl Header

pub fn builder() -> Builder

Creates a tabix index header builder.

Examples

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

pub fn format(&self) -> Format

Returns the 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 reference_sequence_name_index(&self) -> usize

Returns the reference sequence name field index.

This index is 0-based.

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 start_position_index(&self) -> usize

Returns the start position field index.

This index is 0-based.

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 end_position_index(&self) -> Option<usize>

Returns the end position field index.

This index is 0-based. It is not set if the format does not have a column for the end position.

Examples

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

pub fn line_comment_prefix(&self) -> u8

Returns the 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 line_skip_count(&self) -> u32

Returns the number of lines to skip.

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 reference_sequence_names(&self) -> &ReferenceSequenceNames

Returns the 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 reference_sequence_names_mut(&mut self) -> &mut ReferenceSequenceNames

Returns a mutable reference to the reference sequence names.

Examples

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

let reference_sequence_names = ReferenceSequenceNames::new();

let mut header = Header::default();
*header.reference_sequence_names_mut() = reference_sequence_names.clone();

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

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Header

fn eq(&self, other: &Header) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Header

impl StructuralPartialEq for Header