Enum apollo_router::SchemaSource

#[non_exhaustive]
pub enum SchemaSource {
    Static {
        schema_sdl: String,
    },
    Stream(Pin<Box<dyn Stream<Item = String> + Send>>),
    File {
        path: PathBuf,
        watch: bool,
        delay: Option<Duration>,
    },
    Registry(UplinkConfig),
    URLs {
        urls: Vec<Url>,
        watch: bool,
        period: Duration,
    },
}

The user supplied schema. Either a static string 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

Fields

schema_sdl: String

A static schema.

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

A stream of schema.

File

Fields

path: PathBuf

The path of the schema 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 schema. Note: This variable is deprecated and has no effect.

A YAML file that may be watched for changes.

Registry(UplinkConfig)

Apollo managed federation.

URLs

Fields

urls: Vec<Url>

The URLs to fetch the schema from.

watch: bool

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

period: Duration

When watching, the delay to wait between each poll.

A list of URLs to fetch the schema from.

Trait Implementations

impl Debug for SchemaSource

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

Formats the value using the given formatter.

impl Display for SchemaSource

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

Formats the value using the given formatter.

impl From<&str> for SchemaSource

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<(PathBuf, bool, Option<Duration>)> for SchemaSource

fn from(original: (PathBuf, bool, Option<Duration>)) -> SchemaSource

Converts to this type from the input type.

impl From<(Vec<Url>, bool, Duration)> for SchemaSource

fn from(original: (Vec<Url>, bool, Duration)) -> SchemaSource

Converts to this type from the input type.

impl From<Pin<Box<dyn Stream<Item = String> + Send>>> for SchemaSource

fn from(original: Pin<Box<dyn Stream<Item = String> + Send>>) -> SchemaSource

Converts to this type from the input type.

impl From<String> for SchemaSource

fn from(original: String) -> SchemaSource

Converts to this type from the input type.

impl From<UplinkConfig> for SchemaSource

fn from(original: UplinkConfig) -> SchemaSource

Converts to this type from the input type.