Struct noodles::tabix::index::header::Header

pub struct Header { /* fields omitted */ }

A tabix index header.

Implementations

impl Header

pub fn builder() -> Builder

Creates a tabix index header builder.

Examples

use noodles_tabix as tabix;
let builder = tabix::index::Header::builder();

pub fn format(&self) -> Format

Returns the format.

Examples

use noodles_tabix::{self as tabix, index::header::Format};

let header = tabix::index::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 1-based.

Examples

use noodles_tabix as tabix;

let header = tabix::index::Header::builder()
    .set_reference_sequence_name_index(1)
    .build();

assert_eq!(header.reference_sequence_name_index(), 1);

pub fn start_position_index(&self) -> usize

Returns the start position field index.

This index is 1-based.

Examples

use noodles_tabix as tabix;

let header = tabix::index::Header::builder()
    .set_start_position_index(4)
    .build();

assert_eq!(header.start_position_index(), 4);

pub fn end_position_index(&self) -> Option<usize>

Returns the end position field index.

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

Examples

use noodles_tabix as tabix;

let header = tabix::index::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_tabix as tabix;

let header = tabix::index::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_tabix as tabix;

let header = tabix::index::Header::builder()
    .set_line_skip_count(0)
    .build();

assert_eq!(header.line_skip_count(), 0);

Trait Implementations

impl Clone for Header

pub 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

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

Formats the value using the given formatter.

impl Default for Header

pub fn default() -> Header

Returns the “default value” for a type.

impl PartialEq<Header> for Header

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header