Struct Indexer

pub struct Indexer { /* private fields */ }

A tabix indexer.

Implementations

impl Indexer

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

Sets an index header.

Examples

use noodles_csi::binning_index::index::Header;
use noodles_tabix::index::Indexer;
let builder = Indexer::default().set_header(Header::default());

pub fn add_record( &mut self, reference_sequence_name: &str, start: Position, end: Position, chunk: Chunk, ) -> Result<()>

Adds a record.

Examples

use noodles_bgzf as bgzf;
use noodles_core::Position;
use noodles_csi::binning_index::index::reference_sequence::bin::Chunk;
use noodles_tabix::index::Indexer;

let mut indexer = Indexer::default();

let start = Position::try_from(8)?;
let end = Position::try_from(13)?;

indexer.add_record("sq0", start, end, 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 index = tabix::index::Indexer::default().build();

Trait Implementations

impl Debug for Indexer

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

Formats the value using the given formatter.

impl Default for Indexer

fn default() -> Indexer

Returns the “default value” for a type.