Struct noodles_bgzf::virtual_position::VirtualPosition

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

A BGZF virtual position.

A virtual position is a 64-bit unsigned integer representing both the position in the compressed stream and position in the uncompressed block data. The compressed position is typically at the start of a block.

The compressed position is the first six most significant bytes; and the uncompressed position, the last two least significant bytes. For example, for the virtual position 10253313912875616487:

                      compressed position
                       |               |
10253313912875616487 = 8e 4b 16 ad eb 85 88 e7
                                         |   |
                                 uncompressed position

The compressed position is at 156453154188165 (8e 4b 16 ad eb 85); and the uncompressed position, 35047 (88 e7).

This is also called a virtual file offset; or, simply, a virtual offset.

Implementations

impl VirtualPosition

pub const MIN: Self = _

The minimum value of a virtual position.

pub const MAX: Self = _

The maximum value of a virtual position.

pub const fn new(compressed_pos: u64, uncompressed_pos: u16) -> Option<Self>

Creates a virtual position if the compressed position is valid.

Examples

use noodles_bgzf::VirtualPosition;
assert_eq!(VirtualPosition::new(0, 0), Some(VirtualPosition::MIN));
assert!(VirtualPosition::new(1 << 48, 0).is_none());

pub const fn compressed(self) -> u64

The position in the compressed BGZF stream.

This is typically at the start of a block.

The maximum value of a compressed position is 281474976710655 (2^48 - 1).

Examples

use noodles_bgzf as bgzf;
let virtual_position = bgzf::VirtualPosition::from(3741638);
assert_eq!(virtual_position.compressed(), 57);

pub const fn uncompressed(self) -> u16

The position in the uncompressed block data.

The maximum value of an uncompressed position is 65535 (2^16 - 1).

Examples

use noodles_bgzf as bgzf;
let virtual_position = bgzf::VirtualPosition::from(3741638);
assert_eq!(virtual_position.uncompressed(), 6086);

Trait Implementations

impl Clone for VirtualPosition

fn clone(&self) -> VirtualPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualPosition

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

Formats the value using the given formatter.

impl Default for VirtualPosition

fn default() -> VirtualPosition

Returns the “default value” for a type.

impl From<VirtualPosition> for (u64, u16)

fn from(pos: VirtualPosition) -> Self

Converts to this type from the input type.

impl From<VirtualPosition> for u64

fn from(pos: VirtualPosition) -> Self

Converts to this type from the input type.

impl From<u64> for VirtualPosition

fn from(pos: u64) -> Self

Converts to this type from the input type.

impl Ord for VirtualPosition

fn cmp(&self, other: &VirtualPosition) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for VirtualPosition

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for VirtualPosition

fn partial_cmp(&self, other: &VirtualPosition) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<(u64, u16)> for VirtualPosition

fn try_from(pos: (u64, u16)) -> Result<Self, Self::Error>

Converts a (compressed position, uncompressed position) tuple to a virtual position.

Examples

use noodles_bgzf as bgzf;
let virtual_position = bgzf::VirtualPosition::try_from((57, 6086));
assert_eq!(virtual_position, Ok(bgzf::VirtualPosition::from(3741638)));

type Error = TryFromU64U16TupleError

The type returned in the event of a conversion error.

impl Copy for VirtualPosition

impl Eq for VirtualPosition

impl StructuralPartialEq for VirtualPosition