#configuration #settings #config

settingsfile

a library for easy interaction with complex configuration / settings files in multiple formats

1 unstable release

0.2.0 Dec 3, 2018

#8 in #settings

Download history 4/week @ 2018-12-03

1 downloads per month

MIT license

68KB
895 lines

Settingsfile-rs

A library for easily accessing settings and configuration files using Serde.

Status

Usable, but beta. Let me know of any issues you may encounter.

Brief

Settingsfile-rs attempts to abstract away defining, parsing, and saving configuration files for cli and other programs. Taking the heavy lifting away so you can focus on making an easy to use program with a robust set of organized configuration options.

Features

Settigsfile-rs uses a 'tree' method for organizing settings files. This means you can organise different options in groups, allowing you to 'go down the rabit hole' with options and configurations and have it easy for your users to tweak, customize, and have everything exactly as you like it.

Nesting

Each configuration can store properties in a tree, with multiple branches, here is basic example (in JSON)

{
  "user" : {
    "name" : "the user's name",
    "email" : "the user's email",
    "key" : "SDH23UIRWDFHIJSDJF234IOF"
  },
  "display" : {
    "tab-spaces": 2,
    "options" : [ "green", "auto-break" ]
  }
}

As you can see, you can organize different settings by their function, and you can have multiple types used, so numbers, lists, or booleans.

Shadowing

When looking for a settings, Settingsfile-rs looks in 2 places by default. First is the local working directory, and second is the defined place in the configuration. This allows the user to set per folder / per project settings. A good example with git could be a project might be personal so you need your personal key, but if its a work project then you need to use your work key for that organization.

Settingsfile-rs automatically shadows the global setting (defined in the configuration) with the local file (in the working folder) so those will override your global settings. This way the user can define specific settings they may want in this working folder, but not effect the global settings.

Usage

Add Settingsfile-rs to your Cargo.toml file.

[dependencies]
settingsfile = "^0.2"

Then create a struct and implement the Clone + Format trait and then create a new File, in most cases you can use #[derive(Clone)] for Clone. This struct is just a container for how you want the physical settings file to be formated.

extern crate settingsfile;
use settingsfile::Settings;
use settingsfile::Format;
// ...

struct Configuration { }
impl Format for Configuration {
 // implement the functions you need ...
}

fn main() {
  // ...

  // create the `File`
  let settings = Settings::new(Configuration{});

  // reading a value from the settings.
  match settings.get_value("user.name") {
    Ok(user_name) => println!("{}",user_name),
    Err(error) => println!("user.name is not defined."),
  }

  // reading a value and supplying a default in case it doesn't exist or 
  println!("{}",settings.get_value_or("user.name","username is not defined"));

  // and saving data is just as easy.
  settings.set_value("user.name","snsvrno");
  
  // ...
}

Keys are accessed by using a 'dot notation', so this means that you can't include '.' in your key names, but you can nest values and work with trees easily.

// using the previous initalization

if let Ok(user_tree) = settings.get_value("user") {
  // this will give you all the settings nested under user,
  // so you can access or save them as a different file / or 
  // you can easily just remove them all by using `delete_key`.

  settings.get_value("name") // equivalent to "user.name" because we are inside "user"
  ...
}

One note is that these are copies so manipulating content from get_value will not work. You will need to use set_value to do any permanent manipulation.

Dependencies

~2MB
~34K SLoC