Enum apollo_router::ConfigurationSource

#[non_exhaustive]
pub enum ConfigurationSource {
    Static(Box<Configuration>),
    Stream(Pin<Box<dyn Stream<Item = Configuration> + Send>>),
    File {
        path: PathBuf,
        watch: bool,
        delay: Option<Duration>,
    },
}

The user supplied config. Either a static instance or a stream for hot reloading.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Static(Box<Configuration>)

A static configuration.

Can be created through serde::Deserialize from various formats, or inline in Rust code with serde_json::json! and serde_json::from_value.

Stream(Pin<Box<dyn Stream<Item = Configuration> + Send>>)

A configuration stream where the server will react to new configuration. If possible the configuration will be applied without restarting the internal http server.

File

Fields

path: PathBuf

The path of the configuration file.

watch: bool

true to watch the file for changes and hot apply them.

delay: Option<Duration>

👎Deprecated

When watching, the delay to wait before applying the new configuration. Note: This variable is deprecated and has no effect.

A yaml file that may be watched for changes

Trait Implementations

impl Debug for ConfigurationSource

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

Formats the value using the given formatter.

impl Default for ConfigurationSource

fn default() -> Self

Returns the “default value” for a type.

impl Display for ConfigurationSource

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

Formats the value using the given formatter.

impl From<Box<Configuration>> for ConfigurationSource

fn from(original: Box<Configuration>) -> ConfigurationSource

Converts to this type from the input type.

impl From<Configuration> for ConfigurationSource

fn from(original: Configuration) -> ConfigurationSource

Converts to this type from the input type.