Struct Settings 

pub struct Settings { /* private fields */ }

Global runtime settings

Implementations

impl Settings

pub fn initialize() -> Self

Read settings from “.env” file

If values do not exist in “.env” file, then default values are used. However, “.env” is not updated.

Returns

Fully initialized Settings

pub fn version(&self) -> &String

Getter for version

Returns

Immutable reference to internal String representing current version of “sensd”

pub fn root_path(&self) -> RootPath

Getter for root_path

Returns

A cloned reference to internal root_path. If this reference is not dropped (ie: stored as a field in a struct), then Settings::set_root() will panic.

pub fn set_root<P>(&mut self, path: P)

where P: Into<RootPath>,

Setter for root_path.

This method can only be called before initialization

Parameters

• path: New path of top-level directory. Coerces values into String.

Panics

Panics is thrown if any objects are already using this path. This would happen if not called before initialization of crate::storage::Group’s or crate::storage::Log’s.

Trait Implementations

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Settings

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