Struct noodles::tabix::index::Indexer

pub struct Indexer { /* fields omitted */ }

A tabix indexer.

Implementations

impl Indexer

pub fn set_header(&mut self, header: Header)

Sets an index header.

Examples

use noodles_tabix as tabix;
let builder = tabix::Index::indexer().set_header(tabix::index::Header::default());

pub fn add_record(
    &mut self,
    reference_sequence_name: &str,
    start: i32,
    end: i32,
    chunk: Chunk
)

Adds a record.

Examples

use noodles_bgzf as bgzf;
use noodles_csi::index::reference_sequence::bin::Chunk;
use noodles_tabix as tabix;

let mut indexer = tabix::Index::indexer();

indexer.add_record("sq0", 8, 13, Chunk::new(
    bgzf::VirtualPosition::from(144),
    bgzf::VirtualPosition::from(233),
));

pub fn build(self) -> Index

Builds a tabix index.

Examples

use noodles_tabix as tabix;
let indexer = tabix::Index::indexer();
let index = indexer.build();

Trait Implementations

impl Debug for Indexer

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

Formats the value using the given formatter.

impl Default for Indexer

pub fn default() -> Indexer

Returns the “default value” for a type.