Skip to main content

ConfigError

Enum ConfigError 

Source
pub enum ConfigError {
    MissingToken,
    PartialTlsFiles,
    PartialTlsAcme,
    BothTlsModes,
    TrustedIpHeaderWithTls,
    TlsRequired,
    NoAcmeDomains,
    WildcardAcmeDomain(String),
    InvalidFlag {
        var: &'static str,
        value: String,
    },
}
Expand description

Why the server cannot start.

Variants§

§

MissingToken

Mirrors the Node server’s refusal to start without auth — a server reachable from the internet with no token is not a degraded mode worth supporting.

§

PartialTlsFiles

RECALL_TLS_CERT and RECALL_TLS_KEY name one file each; half a pair is almost always a typo in one of the two variable names.

§

PartialTlsAcme

RECALL_TLS_ACME_DOMAINS and RECALL_TLS_ACME_EMAIL are the same kind of pair, for the same reason.

§

BothTlsModes

The two TLS modes are mutually exclusive: each picks its own certificate source, and a config with both is ambiguous about which one wins rather than a config this server can just run.

§

TrustedIpHeaderWithTls

With direct TLS there is no ingress, so the socket’s own peer address is the only client IP that is not the client’s own choice. Setting this variable anyway is either a no-op or, if it is ever read, a way for a client to buy itself an unlimited number of token guesses by rotating whatever header it names, so refusing to start beats silently ignoring the setting.

An explicitly empty value is the one exception: it means “trust no header”, which is exactly what TLS forces anyway, so deploy/docker-compose.direct.yml sets it that way as a second guard, in case its TLS variables ever go missing and the server comes up as plain HTTP instead.

§

TlsRequired

RECALL_TLS_REQUIRED is set, but neither TLS mode is configured. A deployment that publishes its port straight to the internet (deploy/docker-compose.direct.yml) must never come up as plain HTTP just because its certificate variables went missing or empty: that would put the bearer token on the wire in clear text.

§

NoAcmeDomains

RECALL_TLS_ACME_DOMAINS was set but named no domain at all (only commas or whitespace). There is nothing to ask a certificate for, and a server with no certificate fails every handshake.

§

WildcardAcmeDomain(String)

TLS-ALPN-01, the only challenge this server answers, cannot prove control of a wildcard name (Let’s Encrypt requires DNS-01 for those), so an order for one could only ever fail, over and over, on the ACME directory’s rate limit.

§

InvalidFlag

A yes/no setting whose value is neither. Unlike the numeric tunables, which fall back to a default on a typo, these two decide whether the server may run without TLS and which certificate authority it trusts, so guessing either way would be wrong somewhere.

Fields

§var: &'static str

The variable’s name.

§value: String

What it was set to.

Trait Implementations§

Source§

impl Clone for ConfigError

Source§

fn clone(&self) -> Self

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 ConfigError

Source§

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

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

impl Display for ConfigError

Source§

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

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

impl Error for ConfigError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. 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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

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

impl<T> Instrument for T

Source§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

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

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