Struct PersistedDocumentsPlugin 

pub struct PersistedDocumentsPlugin { /* private fields */ }

Trait Implementations

impl Drop for PersistedDocumentsPlugin

fn drop(&mut self)

Executes the destructor for this type.

impl Plugin for PersistedDocumentsPlugin

type Config = Config

The configuration for this plugin. Typically a struct with #[derive(serde::Deserialize)].

fn new<'async_trait>( init: PluginInit<Config>, ) -> Pin<Box<dyn Future<Output = Result<Self, BoxError>> + Send + 'async_trait>>

where Self: 'async_trait,

This is invoked once after the router starts and compiled-in plugins are registered.

fn router_service(&self, service: BoxService) -> BoxService

This function is EXPERIMENTAL and its signature is subject to change.

fn supergraph_service( &self, service: BoxService<Request, Response, Box<dyn Error + Sync + Send>>, ) -> BoxService<Request, Response, Box<dyn Error + Sync + Send>>

This service runs after the HTTP request payload has been deserialized into a GraphQL request, and before the GraphQL response payload is serialized into a raw HTTP response. Define supergraph_service if your customization needs to interact at the earliest or latest point possible, yet operates on GraphQL payloads.

fn execution_service( &self, service: BoxService<Request, Response, Box<dyn Error + Sync + Send>>, ) -> BoxService<Request, Response, Box<dyn Error + Sync + Send>>

This service handles initiating the execution of a query plan after it’s been generated. Define execution_service if your customization includes logic to govern execution (for example, if you want to block a particular query based on a policy decision).

fn subgraph_service( &self, _subgraph_name: &str, service: BoxService<Request, Response, Box<dyn Error + Sync + Send>>, ) -> BoxService<Request, Response, Box<dyn Error + Sync + Send>>

This service handles communication between the Apollo Router and your subgraphs. Define subgraph_service to configure this communication (for example, to dynamically add headers to pass to a subgraph). The _subgraph_name parameter is useful if you need to apply a customization only specific subgraphs.

fn name(&self) -> &'static str

where Self: Sized,

Return the name of the plugin.

fn web_endpoints(&self) -> MultiMap<ListenAddr, Endpoint>

Return one or several Endpoints and ListenAddr and the router will serve your custom web Endpoint(s).