Struct Options

pub struct Options {
    pub verbose: bool,
    pub threads: Option<usize>,
    pub cancellation_token: Option<CancellationToken>,
    pub log_stream: Option<Sender<LogLine>>,
    pub additional_args: Vec<OsString>,
    pub log_command: bool,
}

Options for the conversion process.

Some of these are passed directly to the BSPC executable.

Fields

verbose: bool

Whether to use verbose logging.

If this is false, then the -noverbose flag will be passed to the BSPC executable.

threads: Option<usize>

The number of threads to use for the conversion. By default, multi-threading is disabled (equivalent to setting this to 1).

This is passed to the BSPC executable via the -threads flag.

cancellation_token: Option<CancellationToken>

A cancellation token that can be used to cancel the conversion (instead of dropping the future). See the docs on convert for more information.

log_stream: Option<Sender<LogLine>>

An optional channel to send log lines to as they get logged.

additional_args: Vec<OsString>

Additional command-line arguments to pass to the BSPC executable. These are added at the end, after all other arguments.

log_command: bool

Whether to log the command that is being executed.

Implementations

impl Options

pub fn builder() -> OptionsBuilder