Struct nix_installer::settings::CommonSettings

pub struct CommonSettings {

    pub determinate_nix: bool,
    pub modify_profile: bool,
    pub nix_build_group_name: String,
    pub nix_build_group_id: u32,
    pub nix_build_user_prefix: String,
    pub nix_build_user_count: u32,
    pub nix_build_user_id_base: u32,
    pub nix_package_url: Option<UrlOrPath>,
    pub proxy: Option<Url>,
    pub ssl_cert_file: Option<PathBuf>,
    pub extra_conf: Vec<UrlOrPathOrString>,
    pub force: bool,
    pub diagnostic_attribution: Option<String>,
    pub diagnostic_endpoint: Option<String>,
}

Common settings used by all BuiltinPlanners

Settings which only apply to certain Planners should be located in the planner.

Fields

determinate_nix: bool

Enable Determinate Nix. See: https://determinate.systems/enterprise

modify_profile: bool

Modify the user profile to automatically load Nix

nix_build_group_name: String

The Nix build group name

nix_build_group_id: u32

The Nix build group GID

nix_build_user_prefix: String

The Nix build user prefix (user numbers will be postfixed)

nix_build_user_count: u32

The number of build users to create

nix_build_user_id_base: u32

The Nix build user base UID (ascending)

nix_package_url: Option<UrlOrPath>

The Nix package URL

proxy: Option<Url>

The proxy to use (if any); valid proxy bases are https://$URL, http://$URL and socks5://$URL

ssl_cert_file: Option<PathBuf>

An SSL cert to use (if any); used for fetching Nix and sets ssl-cert-file in /etc/nix/nix.conf

extra_conf: Vec<UrlOrPathOrString>

Extra configuration lines for /etc/nix.conf

force: bool

If nix-installer should forcibly recreate files it finds existing

diagnostic_attribution: Option<String>

Relate the install diagnostic to a specific value

diagnostic_endpoint: Option<String>

The URL or file path for an installation diagnostic to be sent

Sample of the data sent:

{ “attribution”: null, “version”: “0.4.0”, “planner”: “linux”, “configured_settings”: [ “modify_profile” ], “os_name”: “Ubuntu”, “os_version”: “22.04.1 LTS (Jammy Jellyfish)”, “triple”: “x86_64-unknown-linux-gnu”, “is_ci”: false, “action”: “Install”, “status”: “Success” }

To disable diagnostic reporting, unset the default with --diagnostic-endpoint "", or NIX_INSTALLER_DIAGNOSTIC_ENDPOINT=""

Implementations

impl CommonSettings

pub async fn default() -> Result<Self, InstallSettingsError>

The default settings for the given Architecture & Operating System

pub fn settings(&self) -> Result<HashMap<String, Value>, InstallSettingsError>

A listing of the settings, suitable for Planner::settings

Trait Implementations

impl Args for CommonSettings

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl Clone for CommonSettings

fn clone(&self) -> CommonSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CommonSettings

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for CommonSettings

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommonSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for CommonSettings

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CommonSettings

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Serialize for CommonSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.