Struct apollo_router::graphql::IncrementalResponse

#[non_exhaustive]
pub struct IncrementalResponse {
    pub label: Option<String>,
    pub data: Option<Value>,
    pub path: Option<Path>,
    pub errors: Vec<Error>,
    pub extensions: Map<ByteString, Value>,
}

A graphql incremental response. Used with @defer

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.

Implementations

impl IncrementalResponse

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

append_errors default the errors path with the one provided.

impl IncrementalResponse

pub fn builder( ) -> __IncrementalResponseBuilder<(__Optional<Option<String>>, __Optional<Option<Value>>, __Optional<Option<Path>>, __Optional<Vec<Error>>, __Optional<Map<ByteString, Value>>)>

Constructor

Trait Implementations

impl Clone for IncrementalResponse

fn clone(&self) -> IncrementalResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncrementalResponse

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

Formats the value using the given formatter.

impl Default for IncrementalResponse

fn default() -> IncrementalResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IncrementalResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IncrementalResponse

fn eq(&self, other: &IncrementalResponse) -> 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 IncrementalResponse

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 IncrementalResponse

impl StructuralPartialEq for IncrementalResponse