Struct Sinks 

pub struct Sinks {
    pub out: Option<PathBuf>,
    pub clean: bool,
    pub echo: bool,
    pub timeline: bool,
    pub run_log: bool,
    pub zone_ply: bool,
    pub snapshots: bool,
    pub models: bool,
    pub live_stride: usize,
}

Output hook plan. If out is unset, no files are written (enabled file items are ignored, only hooks remain).

Fields

out: Option<PathBuf>

Output folder.

clean: bool

Delete and recreate the output folder when the run starts.

echo: bool

Also write the run.log contents to standard output.

timeline: bool

timeline.txt.

run_log: bool

run.log, DONE.

zone_ply: bool

Zone PLY (full/preview, full/refined).

snapshots: bool

Alignment, snapshots, manifest, final_frame.

models: bool

Per-zone sparse models (work/models/).

live_stride: usize

Live display thinning: keep 1 of live_stride points by key hash (1 = keep all; ≥ 1).

Implementations

impl Sinks

pub fn default_files(out: impl Into<PathBuf>) -> Self

The same file output as cumulus3d stream (excluding sparse models, also logged to standard output, folder recreated at start).

pub fn none() -> Self

No file output (no output folder, no standard output logging).

pub fn clean(self, on: bool) -> Self

Whether to delete the output folder at start.

pub fn echo(self, on: bool) -> Self

Whether to log to standard output.

pub fn timeline(self, on: bool) -> Self

Whether to write timeline.txt.

pub fn run_log(self, on: bool) -> Self

Whether to write run.log.

pub fn zone_ply(self, on: bool) -> Self

Whether to write zone PLY.

pub fn snapshots(self, on: bool) -> Self

Whether to write snapshot/alignment output.

pub fn models(self, on: bool) -> Self

Whether to write per-zone sparse models.

pub fn live_stride(self, stride: usize) -> Self

Live display thinning stride (1 = keep all).

Trait Implementations

impl Clone for Sinks

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sinks

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

Formats the value using the given formatter.

impl Default for Sinks

fn default() -> Self

Sinks::default_files without an output folder (the remaining values when only part of [sinks] is written in TOML).

impl<'de> Deserialize<'de> for Sinks

where Sinks: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sinks

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Sinks

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Sinks