Struct BuildParams 

pub struct BuildParams {

    pub input: GraphInput,
    pub seqs: Vec<String>,
    pub lists: Vec<String>,
    pub dirs: Vec<String>,
    pub k: u16,
    pub minimizer_len: u16,
    pub cutoff: Option<u32>,
    pub color: bool,
    pub compress_buckets: bool,
    pub skip_unreadable: bool,
    pub output_prefix: String,
    pub work_dir: String,
    pub vertex_partitions: usize,
    pub lmtig_buckets: usize,
    pub gmtig_buckets: usize,
    pub threads: usize,
    pub max_memory_gb: Option<usize>,
}

Configuration shared by partitioning and graph construction phases.

Bucket and partition counts must be powers of two. The public fields support programmatic construction, while BuildParams::validate enforces the cross-field invariants expected by the production pipeline.

Fields

input: GraphInput

Whether inputs are sequencing reads or references.

seqs: Vec<String>

Explicit sequence file paths.

lists: Vec<String>

Files containing one input path per line.

dirs: Vec<String>

Directories whose regular files are used as inputs.

k: u16

K-mer length. Must be odd and no greater than crate::MAX_K.

minimizer_len: u16

Minimizer length used for weak-super-k-mer partitioning.

cutoff: Option<u32>

Optional edge-frequency cutoff; input-class defaults apply when absent.

color: bool

Whether to construct and emit positional colors.

compress_buckets: bool

Whether weak-super-k-mer buckets use LZ4 block compression.

On by default. Colored builds compress regardless; for uncolored ones this cuts write volume on a 150k reference build from 1167.7 GB to 439 GB and peak RSS by about a quarter, at no measurable cost in wall time across five interleaved pairs at 64 threads.

skip_unreadable: bool

Whether an input that fails to parse is skipped instead of aborting.

A skipped source retains its position in the input list, so colored source assignments are unaffected. Records read before the failure are retained, so a file that fails part-way through contributes its prefix.

output_prefix: String

Prefix for final graph files.

work_dir: String

Directory for external-memory intermediates.

vertex_partitions: usize

Number of blocked discontinuity-graph vertex partitions.

lmtig_buckets: usize

Logical local-unitig bucket count.

gmtig_buckets: usize

Logical maximal-unitig coordinate bucket count.

threads: usize

Maximum worker count requested for each phase.

max_memory_gb: Option<usize>

Optional soft memory budget in GiB.

The budget controls replicated phase state and is not a hard RSS limit.

Implementations

impl BuildParams

pub fn new(input: GraphInput, output_prefix: String) -> Self

Constructs parameters with Cuttlefish-compatible defaults.

pub fn cutoff(&self) -> u32

Returns the explicit cutoff or the input-class default.

pub fn max_memory_bytes(&self) -> Option<usize>

Returns the soft memory budget in bytes, if configured.

pub fn partition_workers(&self, input_files: usize) -> usize

Returns the partition worker count after input and memory bounds.

pub fn local_workers(&self) -> usize

Returns the memory-bounded local-contraction worker count.

pub fn post_local_workers(&self) -> usize

Returns the memory-bounded discontinuity/collation worker count.

pub fn validate(&self) -> Result<(), ParamError>

Validates input, graph dimensions, and resource parameters.

Trait Implementations

impl Clone for BuildParams

fn clone(&self) -> BuildParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildParams

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

Formats the value using the given formatter.

impl Eq for BuildParams

impl PartialEq for BuildParams

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BuildParams