Struct CoordinateKey 

pub struct CoordinateKey {
    pub tid: i32,
    pub pos: i64,
    pub reverse: bool,
}

Sort key for coordinate ordering.

Sort order: reference ID → position → reverse strand flag. Unmapped reads (tid = -1) are sorted to the end.

Note: No read name tie-breaking is used, matching samtools behavior. Equal records maintain their original input order (stable sort).

Fields

tid: i32

Reference sequence ID (tid), or i32::MAX for unmapped.

pos: i64

0-based alignment start position.

reverse: bool

True if reverse strand.

Implementations

impl CoordinateKey

pub fn unmapped() -> Self

Create a coordinate key for an unmapped read.

Trait Implementations

impl Clone for CoordinateKey

fn clone(&self) -> CoordinateKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoordinateKey

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

Formats the value using the given formatter.

impl Ord for CoordinateKey

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl PartialEq for CoordinateKey

fn eq(&self, other: &CoordinateKey) -> 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 PartialOrd for CoordinateKey

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl SortKey for CoordinateKey

type Context = ()

Context built once from header (e.g., LibraryIndex for template-coordinate). Use () for keys that don’t need context.

fn build_context(_header: &Header) -> Self::Context

Build context from header (called once at sort start).

fn from_record( record: &RecordBuf, _header: &Header, _ctx: &Self::Context, ) -> Result<Self>

Extract a sort key from a BAM record using pre-built context.

impl Eq for CoordinateKey

impl StructuralPartialEq for CoordinateKey