Struct FigCon 

pub struct FigCon { /* private fields */ }

FigCon

A simple synchronous config manager that relies on serde_json

It stores its own path location and can be saved/reloaded at any time

Implementations

impl FigCon

pub fn load_or_default(path: PathBuf) -> Self

Initialize the FigCon

Attempts to load a config file with the given PathBuf and returns an empty FigCon when it fails

pub fn set_path(&mut self, path: PathBuf)

Set Config Path

Changing the location during runtime will not affect the live config, and it will not save to the new location automatically.

Use .save() immediately after if you wish to write the live config to the new location

pub fn reload(&mut self) -> Self

Reload Config

Pull the config file again and overwrite the config in memory

pub fn save(&self)

Save Config

Write the current config state synchronously to the file system

pub fn get(&self, key: String) -> Value

Get

Get a serde_json Value with a specified key

pub fn set(&mut self, key: String, val: Value)

Set

Set a value with a specified key and serde_json Value

pub fn get_st(&self, key: &str) -> Value

Get (Static)

Get a serde_json Value with a specified key

pub fn set_st(&mut self, key: &str, val: Value)

Set (Static)

Set a value with a specified key and serde_json Value

pub fn set_str_st(&mut self, key: &str, val: &str)

Set String (Static)

Set a value with a specified key and static string

pub fn del(&mut self, key: String) -> Option<Value>

Delete

Removes an entry with a specified key. Returns an option with the deleted Value (if it exists)

pub fn del_st(&mut self, key: &str) -> Option<Value>

Delete (Static)

Removes an entry with a specified key. Returns an option with the deleted Value (if it exists)

pub fn has(&self, key: String) -> bool

Has Key

Checks if a key exists with a specified name

pub fn has_st(&self, key: &str) -> bool

Has Key (Static)

Checks if a key exists with a specified name

Trait Implementations

impl Clone for FigCon

fn clone(&self) -> FigCon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FigCon

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

Formats the value using the given formatter.

impl Display for FigCon

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

A potentially slow function which attempts to display the entire configuration as a prettified json string.

It would be inadvisable to use this on larger configurations during runtime.