Struct Locs 

pub struct Locs {
    pub chr_ids: Vec<String>,
    pub starts: Vec<i64>,
    pub ends: Vec<i64>,
    pub strands: Vec<Strand>,
}

A request’s regions, before they are resolved against a file.

Fields

chr_ids: Vec<String>

starts: Vec<i64>

ends: Vec<i64>

strands: Vec<Strand>

One per locus, or empty for all-forward.

Implementations

impl Locs

pub fn parse( chr_ids: &[String], starts: &[i64], ends: &[i64], centers: &[i64], span: Option<i64>, ) -> Result<Self>

The runtime-dispatched form, for the Python layer.

Accepts one of: starts + ends with no span; or exactly one of starts / ends / centers together with span. span of None means no span was given, and so does Some(-1) — the Python layer has no Option to pass and uses -1 as the sentinel. Anything below that is refused: a caller reaching this from Rust with Some(-5) means something, and silently reading it as “no span” is not it.

No loci at all is a request for nothing rather than a malformed one — every reader handles an empty batch — and that is checked first, because the tests below read an empty starts/ends as “not given”.

pub fn spans(chr_ids: &[String], starts: &[i64], ends: &[i64]) -> Result<Self>

starts and ends given directly.

pub fn from_starts( chr_ids: &[String], starts: &[i64], span: i64, ) -> Result<Self>

ends[i] = starts[i] + span.

pub fn from_ends(chr_ids: &[String], ends: &[i64], span: i64) -> Result<Self>

starts[i] = ends[i] - span.

pub fn centered(chr_ids: &[String], centers: &[i64], span: i64) -> Result<Self>

[c - span/2, c + (span + 1)/2).

pub fn chromosomes(chr_ids: Vec<String>) -> Self

Chromosome names and nothing else.

What the whole-file calls take: they resolve the regions themselves from the file’s chromosome sizes, so there are no coordinates to give. Locs::parse refuses this shape — with no starts and no span there is nothing for it to build — which is right for a request that names windows and wrong for one that names chromosomes.

pub fn whole_chromosomes(map: &ChrMap, chr_ids: &[String]) -> Result<Self>

Every named chromosome end to end, for the read_all_* and iter_all_* paths. An empty chr_ids means all of them, in the file’s order.

pub fn with_strands(self, strands: &[String]) -> Result<Self>

Empty leaves every locus forward, which is what a request that named no strand gets; anything else must be one entry per locus.

pub fn strand(&self, i: usize) -> Strand

Strand of locus i, forward when none were given.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for Locs

fn clone(&self) -> Locs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Locs

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

Formats the value using the given formatter.

impl Default for Locs

fn default() -> Locs

Returns the “default value” for a type.

impl PartialEq for Locs

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Locs