Struct NixConfig

pub struct NixConfig { /* private fields */ }

A newtype wrapper around a [HashMap], where the key is the name of the Nix setting, and the value is the value of that setting. If the setting accepts a list of values, the value will be space delimited.

Implementations

impl NixConfig

pub fn new() -> Self

pub fn settings(&self) -> &IndexMap<String, String>

pub fn settings_mut(&mut self) -> &mut IndexMap<String, String>

pub fn into_settings(self) -> IndexMap<String, String>

pub fn parse_file(path: &Path) -> Result<Self, ParseError>

Attempt to parse the nix.conf at the provided path.

std::fs::write(
    "nix.conf",
    b"experimental-features = flakes nix-command\nwarn-dirty = false\n",
)?;

let nix_conf = nix_config_parser::NixConfig::parse_file(&std::path::Path::new("nix.conf"))?;

assert_eq!(
    nix_conf.settings().get("experimental-features").unwrap(),
    "flakes nix-command"
);
assert_eq!(nix_conf.settings().get("warn-dirty").unwrap(), "false");

std::fs::remove_file("nix.conf")?;

pub fn parse_string( contents: String, origin: Option<&Path>, ) -> Result<Self, ParseError>

Attempt to parse the nix.conf out of the provided String. The origin parameter is Optional, and only influences potential error messages.

let nix_conf_string = String::from("experimental-features = flakes nix-command");
let nix_conf = nix_config_parser::NixConfig::parse_string(nix_conf_string, None)?;

assert_eq!(
    nix_conf.settings().get("experimental-features").unwrap(),
    "flakes nix-command"
);

Trait Implementations

impl Clone for NixConfig

fn clone(&self) -> NixConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NixConfig

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

Formats the value using the given formatter.

impl Default for NixConfig

fn default() -> NixConfig

Returns the “default value” for a type.

impl PartialEq for NixConfig

fn eq(&self, other: &NixConfig) -> 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 NixConfig

impl StructuralPartialEq for NixConfig