Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub listen: String,
    pub data_dir: PathBuf,
    pub api_token_env: String,
    pub output_dir: Option<PathBuf>,
    pub smtp: Option<SmtpConfig>,
    pub data_hosts: Vec<DataHost>,
    pub max_concurrent_renders: usize,
    pub retry_delay_seconds: u64,
    pub misfire_grace_minutes: u64,
    pub history_limit: usize,
    pub max_body_megabytes: usize,
}
Expand description

The server’s configuration, read from a JSON file.

Fields§

§listen: String

Address and port to listen on; the loopback interface by default.

§data_dir: PathBuf

Where layouts, jobs, history and documents are kept.

§api_token_env: String

The environment variable holding the API token.

§output_dir: Option<PathBuf>

The folder under which folder deliveries write; such deliveries are refused without it.

§smtp: Option<SmtpConfig>

The mail server; email deliveries are refused without it.

§data_hosts: Vec<DataHost>

The hosts url data sources may read from. Any other host is refused.

§max_concurrent_renders: usize

How many reports render at the same time.

§retry_delay_seconds: u64

The wait before the first retry of a failed run; it doubles on each retry.

§misfire_grace_minutes: u64

A run this late (the server was down) still happens; a later one is recorded as missed.

§history_limit: usize

How many runs of each job the history keeps.

§max_body_megabytes: usize

The largest request body accepted, in megabytes.

Implementations§

Source§

impl Config

Source

pub fn new(data_dir: impl Into<PathBuf>) -> Self

A configuration with every default, keeping its data in data_dir.

Source

pub fn load(path: &Path) -> Result<Self, String>

Reads the configuration from a JSON file.

Source

pub fn api_token(&self) -> Result<String, String>

The API token, from the environment. There is no way to run without one.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Finish for T

§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more