Struct Index

pub struct Index(/* private fields */);

A gzip index (GZI).

A gzip index holds compressed-uncompressed position pairs.

Like this physical index, this does not include the position of the first block, which is implicity at 0.

Implementations

impl Index

pub fn query(&self, pos: u64) -> Result<VirtualPosition>

Returns the virtual position at the given uncompressed position.

Examples

use noodles_bgzf::{self as bgzf, gzi};

let index = gzi::Index::default();
assert_eq!(index.query(0)?, bgzf::VirtualPosition::default());

let index = gzi::Index::from(vec![(8, 21), (13, 55)]);
assert_eq!(index.query(0)?, bgzf::VirtualPosition::default());
assert_eq!(index.query(13)?, bgzf::VirtualPosition::try_from((0, 13))?);
assert_eq!(index.query(34)?, bgzf::VirtualPosition::try_from((8, 13))?);
assert_eq!(index.query(89)?, bgzf::VirtualPosition::try_from((13, 34))?);
Ok::<_, Box<dyn std::error::Error>>(())

Trait Implementations

impl AsRef<[(u64, u64)]> for Index

fn as_ref(&self) -> &[(u64, u64)]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.

impl From<Vec<(u64, u64)>> for Index

fn from(index: Vec<(u64, u64)>) -> Self

Converts to this type from the input type.

impl PartialEq for Index

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Index

impl StructuralPartialEq for Index