Struct apollo_router::graphql::Response

#[non_exhaustive]
pub struct Response {
    pub label: Option<String>,
    pub data: Option<Value>,
    pub path: Option<Path>,
    pub errors: Vec<Error>,
    pub extensions: Map<ByteString, Value>,
    pub has_next: Option<bool>,
    pub subscribed: Option<bool>,
    pub created_at: Option<Instant>,
    pub incremental: Vec<IncrementalResponse>,
}

A graphql primary response. Used for federated and subgraph queries.

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.

label: Option<String>

The label that was passed to the defer or stream directive for this patch.

data: Option<Value>

The response data.

path: Option<Path>

The path that the data should be merged at.

errors: Vec<Error>

The optional graphql errors encountered.

extensions: Map<ByteString, Value>

The optional graphql extensions.

has_next: Option<bool>

subscribed: Option<bool>

created_at: Option<Instant>

Used for subscription event to compute the duration of a subscription event

incremental: Vec<IncrementalResponse>

Implementations

impl Response

pub fn is_primary(&self) -> bool

If path is None, this is a primary response.

pub fn append_errors(&mut self, errors: &mut Vec<Error>)

append_errors default the errors path with the one provided.

impl Response

pub fn builder( ) -> __ResponseBuilder<(__Optional<Option<String>>, __Optional<Option<Value>>, __Optional<Option<Path>>, __Optional<Vec<Error>>, __Optional<Map<ByteString, Value>>, __Optional<Option<String>>, __Optional<Option<bool>>, __Optional<Option<bool>>, __Optional<Vec<IncrementalResponse>>, __Optional<Option<Instant>>)>

Constructor

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Response> for Response

fn eq(&self, other: &Response) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Response

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Response

impl StructuralEq for Response

impl StructuralPartialEq for Response