pub enum CompiledGeom {
Simple(SimpleExtractor),
Inferable(InferableExtractor),
BoundaryResolved(BoundaryResolvedExtractor),
}Expand description
A compiled geometry ready for fast extraction.
This is an enum so that callers can match once at startup and then call
the variant-specific extract method in a tight loop with no per-read
branching. The branch predictor would handle the enum match on extract()
perfectly (variant never changes), but callers who want guaranteed zero
overhead can match once and hold the inner type directly.
Variant selection:
CompiledGeom::Simplefor fixed-offset layouts such as1{b[16]u[12]x:}2{r:}CompiledGeom::Inferablefor locally bounded variable-width layouts such as1{b[9-10]f[ACGT]u[12]}2{r:}CompiledGeom::BoundaryResolvedfor layouts that require anchor placement before segments can be assigned, such as1{r:f[ACAGT]b[9-11]}2{u[12]x:}
Variants§
Simple(SimpleExtractor)
Fast path for simple single-barcode geometries (e.g. Chromium v2/v3). BC+UMI on one read at fixed offsets, bio read on the other.
Inferable(InferableExtractor)
Inferable path for anchored or otherwise locally bounded variable-width geometries.
BoundaryResolved(BoundaryResolvedExtractor)
Boundary-resolved path for geometries that require anchor placement before open-ended or variable-width segments can be assigned.
Implementations§
Source§impl CompiledGeom
impl CompiledGeom
Sourcepub fn from_fragment_geom(geom: &FragmentGeom) -> Result<Self, String>
pub fn from_fragment_geom(geom: &FragmentGeom) -> Result<Self, String>
Compile a parsed geometry into an extraction plan.
Sourcepub fn extract<'a>(&self, r1: &'a [u8], r2: &'a [u8]) -> ExtractedSeqs<'a>
pub fn extract<'a>(&self, r1: &'a [u8], r2: &'a [u8]) -> ExtractedSeqs<'a>
Extract sequences from a read pair.
This dispatches to the variant-specific extractor. For maximum
performance in tight loops, match on the enum once at startup and
call the variant’s extract method directly — this eliminates even
the (perfectly-predicted) enum branch.
match compiled {
CompiledGeom::Simple(ext) => {
for (r1, r2) in reads {
let seqs = ext.extract(r1, r2); // no dispatch
}
}
CompiledGeom::Inferable(ext) => {
for (r1, r2) in reads {
let seqs = ext.extract(r1, r2);
}
}
CompiledGeom::BoundaryResolved(ext) => {
for (r1, r2) in reads {
let seqs = ext.extract(r1, r2);
}
}
}Trait Implementations§
Source§impl Clone for CompiledGeom
impl Clone for CompiledGeom
Source§fn clone(&self) -> CompiledGeom
fn clone(&self) -> CompiledGeom
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CompiledGeom
impl RefUnwindSafe for CompiledGeom
impl Send for CompiledGeom
impl Sync for CompiledGeom
impl Unpin for CompiledGeom
impl UnsafeUnpin for CompiledGeom
impl UnwindSafe for CompiledGeom
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);Source§impl<'p, T> Seq<'p, T> for Twhere
T: Clone,
impl<'p, T> Seq<'p, T> for Twhere
T: Clone,
Source§impl<T, S> SpanWrap<S> for Twhere
S: WrappingSpan<T>,
impl<T, S> SpanWrap<S> for Twhere
S: WrappingSpan<T>,
Source§fn with_span(self, span: S) -> <S as WrappingSpan<Self>>::Spanned
fn with_span(self, span: S) -> <S as WrappingSpan<Self>>::Spanned
WrappingSpan::make_wrapped to wrap an AST node in a span.