Struct Executable

#[non_exhaustive]
pub struct Executable {}

Entry point into creating a router executable with more customization than main.

Implementations

impl Executable

pub fn builder() -> __ExecutableBuilder<(__Optional<Option<ShutdownSource>>, __Optional<Option<SchemaSource>>, __Optional<Option<LicenseSource>>, __Optional<Option<ConfigurationSource>>, __Optional<Option<Opt>>)>

Returns a builder that can parse command-line options and run a Router in an existing Tokio runtime.

Builder methods:

• .config(impl Into<ConfigurationSource>) Optional. Specifies where to find the Router configuration. The default is the file specified by the --config or -c CLI option.

• .schema(impl Into<SchemaSource>) Optional. Specifies when to find the supergraph schema. The default is the file specified by the --supergraph or -s CLI option.

• .shutdown(impl Into<ShutdownSource>) Optional. Specifies when the Router should shut down gracefully. The default is on CTRL+C (SIGINT).

• .start() Returns a future that resolves to anyhow::Result<()> on fatal error or after graceful shutdown has completed. Must be called (and the future awaited) in the context of an existing Tokio runtime.

use apollo_router::{Executable, ShutdownSource};
use apollo_router::{ConfigurationSource, SchemaSource};
Executable::builder()
  .shutdown(ShutdownSource::None)
  .schema(SchemaSource::Stream(schemas))
  .config(ConfigurationSource::Stream(configs))
  .start()
  .await