Crate noodles_tabix

noodles-tabix handles the reading and writing of the tabix format.

A tabix (TBI) is an index file typically used to allow random access of an accompanied file that is

1. bgzipped,
2. tab-delimited,
3. grouped by reference sequence name, and
4. coordinate sorted by start position.

It can be used to find relevant records for a given genomic region.

Examples

Read a tabix file

use noodles_tabix as tabix;
let index = tabix::read("sample.vcf.gz.tbi")?;

Re-exports

• pub use self::async::Reader as AsyncReader;
• pub use self::async::Writer as AsyncWriter;

Modules

• async
  Async tabix index and fields.
• index
  Tabix index.
• io
  Tabix I/O.

Structs

• Reader
  A tabix reader.
• Writer
  A tabix writer.

Functions

• read
  Reads the entire contents of a tabix index.
• write
  Writes a tabix index to a file.

Type Aliases

• Index
  A tabix index.