Struct ClientSettings

pub struct ClientSettings {
    pub keep_failed: bool,
    pub keep_going: bool,
    pub try_fallback: bool,
    pub verbosity: Verbosity,
    pub max_build_jobs: u64,
    pub max_silent_time: u64,
    pub verbose_build: bool,
    pub build_cores: u64,
    pub use_substitutes: bool,
    pub overrides: HashMap<String, String>,
}

Passed to Store::set_options().

Fields

keep_failed: bool

Whether to keep temporary directories of failed builds.

Default: false

keep_going: bool

Whether to keep building derivations when another build fails.

Default: false

try_fallback: bool

Whether to fall back to building from source if a binary substitution fails.

Default: false

verbosity: Verbosity

Verbosity.

Default: Verbosity::Error.

max_build_jobs: u64

Number of derivations Nix will attempt to build in parallel.

0 = No local builds will be performed (except preferLocalBuild derivations), only remote builds and substitutions.

This is different from ClientSettings::build_cores, which affects how many cores are used by a single build. In nix.conf, this can also have the magic value “auto”, which uses the number of threads available on the machine, but we can only set it to whole numbers using Store::set_options.

Default: 1

max_silent_time: u64

Number of seconds a build is allowed to produce no stdout or stderr output.

Default: 0

verbose_build: bool

Whether to show build log output in real time.

build_cores: u64

How many cores will be used for an individual build. Sets the NIX_BUILD_CORES environment variable for builders, which is passed to eg. make -j.

0 = Use all available cores on the builder machine.

This is different from ClientSettings::max_build_jobs, which controls ho many derivations Nix will attempt to build in parallel.

NOTE: On the daemon, this defaults to the number of threads that were available when it started, which we of course have no way of knowing, since we don’t even know if we’re running on the same machine. Thus, we default to 0 instead, which in most cases will do the same thing.

If you know you’re on the daemon machine, you can get the available threads with:

use nix_daemon::ClientSettings;

ClientSettings {
    build_cores: std::thread::available_parallelism().unwrap().get() as u64,
    ..Default::default()
};

Default: 0

use_substitutes: bool

Whether to use binary substitutes if available.

Default: true

overrides: HashMap<String, String>

Undocumented. Some additional settings can be set using this field.

Default: HashMap::default().

Trait Implementations

impl Clone for ClientSettings

fn clone(&self) -> ClientSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientSettings

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

Formats the value using the given formatter.

impl Default for ClientSettings

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ClientSettings

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ClientSettings

impl StructuralPartialEq for ClientSettings