Struct GziIndex 

pub struct GziIndex {
    pub entries: Vec<(u64, u64)>,
}

A gzip index for BGZF-compressed files.

Maps uncompressed byte positions to compressed file positions, enabling efficient seeking in compressed files.

Format

Binary format (little-endian):

• First 8 bytes: number of index entries (u64)
• Following bytes: pairs of (compressed_offset, uncompressed_offset) as u64

Example

use fastx::gzi::GziIndex;
use std::path::Path;

let index = GziIndex::from_path(Path::new("data.fasta.gz.gzi")).unwrap();
let compressed_offset = index.get_compressed_offset(10000).unwrap();

Fields

entries: Vec<(u64, u64)>

Sorted entries: (compressed_offset, uncompressed_offset)

Implementations

impl GziIndex

pub fn from_path(path: &Path) -> Result<Self>

Load a .gzi index from a file.

Arguments

• path - Path to the .gzi index file

Returns

• Ok(GziIndex) - The parsed index
• Err(io::Error) - If the file cannot be read or the format is invalid

pub fn from_bytes(buffer: &[u8]) -> Result<Self>

Load a .gzi index from raw bytes.

Arguments

• buffer - Byte slice containing .gzi formatted data

Returns

• Ok(GziIndex) - The parsed index
• Err(io::Error) - If the data is too short or the format is invalid

pub fn get_compressed_offset(&self, uncompressed_offset: u64) -> Option<u64>

Get the compressed offset for a given uncompressed position.

pub fn get_uncompressed_offset(&self, compressed_offset: u64) -> Option<u64>

Get the uncompressed offset for a given compressed position.

pub fn len(&self) -> usize

Get the number of index entries.

pub fn is_empty(&self) -> bool

Check if the index is empty.

pub fn entries(&self) -> &[(u64, u64)]

Get a reference to all entries.

Trait Implementations

impl Clone for GziIndex

fn clone(&self) -> GziIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GziIndex

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

Formats the value using the given formatter.