Struct bam::index::VirtualOffset

pub struct VirtualOffset(_);

Virtual offset. Represents block_offset << 16 | contents_offset, where block_offset is u48 and represents the offset in the bgzip file to the beginning of the block (also known as coffset or compressed_offset).

contents_offset is u16 and represents offset in the uncompressed data in a single block (also known as uoffset or uncompressed_offset).

Implementations

impl VirtualOffset

pub fn from_raw(raw: u64) -> VirtualOffset

Construct virtual offset from raw value.

pub fn new(block_offset: u64, contents_offset: u16) -> Self

Constructs virtual offset from block_offset and contents_offset.

pub fn raw(&self) -> u64

Returns the raw value.

pub fn block_offset(&self) -> u64

Returns the block offset. Represents the offset in the Bgzip file to the beginning of the block.

pub fn contents_offset(&self) -> u16

Represents the contents offset. Represents the offset into the uncompressed contents of the block.

pub fn equal(&self, block_offset: u64, contents_offset: u16) -> bool

Checks if the self is the same as block_offset << 16 | contents_offset.

pub const MIN: VirtualOffset

Minimal possible offset, same as VirtualOffset::from_raw(0).

pub const MAX: VirtualOffset

Maximal possible offset, same as VirtualOffset::from_raw(std::u64::MAX).

Trait Implementations

impl Clone for VirtualOffset

fn clone(&self) -> VirtualOffset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for VirtualOffset

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

Formats the value using the given formatter.

impl Ord for VirtualOffset

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<VirtualOffset> for VirtualOffset

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

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

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

This method tests for !=.

impl PartialOrd<VirtualOffset> for VirtualOffset

fn partial_cmp(&self, other: &VirtualOffset) -> 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 Copy for VirtualOffset

impl Eq for VirtualOffset

impl StructuralEq for VirtualOffset

impl StructuralPartialEq for VirtualOffset