Struct FromSequencesOptions 

#[non_exhaustive]
pub struct FromSequencesOptions {
    pub max_grid_cells: usize,
    /* private fields */
}

Cost knobs for from_sequences.

Nothing here changes which forms the function is willing to emit — that is fixed by the rules, not by the caller (README.md rule 6). max_grid_cells is a memory bound. direction is not a caller-facing knob: it mirrors NormalizeConfig’s internal test instrument, is #[doc(hidden)] for the same reason, and is always ThreePrime on every shipped path.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_grid_cells: usize

Largest alignment grid, in cells, the partitioner will build.

A cell costs roughly 18 bytes on this arm, so the default — (4096 + 1)^2, about 16.8 M cells — admits roughly 310 MB at the limit. Lower it when reads are short and the budget matters; raise it for a long-read haplotype, having read that figure. Exceeding it refuses: this is a cost bound, and refusing rather than silently answering with a weaker rule is the policy.

Implementations

impl FromSequencesOptions

The two setters exist because the struct is #[non_exhaustive], which forbids a struct expression outside this crate — so without them a downstream caller can reach Default::default() and nothing else, and the knobs are documented but unreachable. The bug was found by moving one test into tests/it, which is a separate crate and so sees the same surface a user does.

Named after crate::NormalizeConfig::with_direction, which is the same pattern for the same reason.

pub fn with_max_grid_cells(self, max_grid_cells: usize) -> Self

Set the alignment-grid budget, in cells. See FromSequencesOptions::max_grid_cells for what a cell costs.

Trait Implementations

impl Clone for FromSequencesOptions

fn clone(&self) -> FromSequencesOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FromSequencesOptions

impl Debug for FromSequencesOptions

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

Formats the value using the given formatter.

impl Default for FromSequencesOptions

fn default() -> Self

Returns the “default value” for a type.