Struct Config

pub struct Config {
    pub includes: Vec<String>,
    pub files: Vec<String>,
    pub history: HistoryConfig,
    pub server: ServerConfig,
    pub logging: LoggingConfig,
    pub ui: Config,
    pub tls: TlsConfig,
}

The top level config.

Fields

includes: Vec<String>

The include directories in which to search for the protos

files: Vec<String>

A list of proto files such as [internal.proto, api.proto]

history: HistoryConfig

The history config

server: ServerConfig

The server config

logging: LoggingConfig

The logger config

ui: Config

The ui config

tls: TlsConfig

Optional TLS settings

Implementations

impl Config

pub fn load(file: &str) -> Result<Self>

Loads the config from a file.

Errors

Failed to read the config file.

pub fn serialize_toml(&self) -> Result<String>

Serializes the config to a toml-formatted string.

Errors

Returns an error if serde serialization fails.

pub fn includes(&self) -> Vec<String>

Gets the includes directories. Tries to shell expand the path if it contains environment variables such as $HOME or ~.

pub fn files(&self) -> Vec<String>

Gets the files. Tries to shell expand the path if it contains environment variables such as $HOME or ~.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config