Struct apollo_router::services::supergraph::Request

#[non_exhaustive]
pub struct Request {
    pub supergraph_request: Request<Request>,
    pub context: Context,
}

Represents the router processing step of the processing pipeline.

This consists of the parsed graphql Request, HTTP headers and contextual data for extensions.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

supergraph_request: Request<Request>

Original request to the Router.

context: Context

Context for extension

Implementations

impl Request

pub fn builder() -> NewRequestBuilder

This is the constructor (or builder) to use when constructing a real Request.

Required parameters are required in non-testing code to create a Request.

impl Request

pub fn fake_builder() -> FakeNewRequestBuilder

This is the constructor (or builder) to use when constructing a “fake” Request.

This does not enforce the provision of the data that is required for a fully functional Request. It’s usually enough for testing, when a fully constructed Request is difficult to construct and not required for the purposes of the test.

In addition, fake requests are expected to be valid, and will panic if given invalid values.

impl Request

pub fn canned_builder() -> CannedNewRequestBuilder

Create a request with an example query, for tests

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl From<Request<Request>> for Request

fn from(supergraph_request: Request<Request>) -> Self

Converts to this type from the input type.

impl Service<Request> for MockSupergraphService

type Response = Response

Responses given by the service.

type Error = Box<dyn Error + Sync + Send>

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<MockSupergraphService as Service<Request>>::Response, <MockSupergraphService as Service<Request>>::Error>> + Send>>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), BoxError>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: SupergraphRequest) -> Self::Future

Process the request and return the response asynchronously.

impl TryFrom<Request> for Request

This is handy for tests.

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(request: Request) -> Result<Self, Self::Error>

Performs the conversion.