Struct LibraryTypeDetector 

pub struct LibraryTypeDetector { /* private fields */ }

Accumulates observed library formats and infers the most likely type.

Every field is atomic and every method takes &self: all the mapping threads feed one shared detector while they work.

Implementations

impl LibraryTypeDetector

pub fn new(read_type: ReadType) -> Self

A detector for single- or paired-end input, with a fresh sample budget.

pub fn is_active(&self) -> bool

Whether the detector is still collecting samples.

pub fn can_guess(&self) -> bool

True once enough samples have been collected to guess.

pub fn add_sample(&self, f: LibraryFormat)

Record one confidently mapped fragment’s observed format. Only formats matching the detector’s read type are counted, and only until the sample budget is exhausted. Thread-safe.

“Confidently mapped” matters: an ambiguous mapping’s orientation is not evidence about the protocol, so the caller filters before calling.

pub fn resolved_format(&self) -> Option<LibraryFormat>

Mid-run resolution (salmon’s prefix-detect-then-apply): once enough samples have been collected (Self::can_guess), infer and lock in the library format (one writer wins the CAS), stop sampling, and return it; idempotent thereafter. Returns None while still sampling. The caller applies the returned format as a strand-compatibility filter for the rest of the run.

The compare-and-swap is what makes this safe under concurrency: several threads may notice the budget is spent at the same moment and infer (possibly slightly different) formats from a racing snapshot of the counts, but exactly one store succeeds and every thread then uses that same answer.

pub fn final_format(&self) -> LibraryFormat

The final library format to report at end of run: the locked-in format if resolution happened mid-run, else inferred from whatever samples were collected (recorded so repeat calls agree). Always returns a format.

Needed because a small input may finish before the sample budget is spent; there is still a best guess to report, it just never became a filter.

Trait Implementations

impl Debug for LibraryTypeDetector

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

Formats the value using the given formatter.