Struct GraphQLError 

pub struct GraphQLError {
    pub message: String,
    pub locations: Option<Vec<GraphQLErrorLocation>>,
    pub path: Option<GraphQLErrorPath>,
    pub extensions: GraphQLErrorExtensions,
}

Fields

message: String

locations: Option<Vec<GraphQLErrorLocation>>

path: Option<GraphQLErrorPath>

extensions: GraphQLErrorExtensions

Implementations

impl GraphQLError

pub fn entity_index_and_path<'a>(&'a self) -> Option<EntityIndexAndPath<'a>>

pub fn normalize_entity_error( self, entity_index_error_map: &HashMap<&usize, Vec<GraphQLErrorPath>>, ) -> Vec<GraphQLError>

pub fn from_message_and_extensions<TMessage: Into<String>>( message: TMessage, extensions: GraphQLErrorExtensions, ) -> Self

Creates a GraphQLError with the given message and extensions. Example:

use hive_router_plan_executor::response::graphql_error::GraphQLError;
use hive_router_plan_executor::response::graphql_error::GraphQLErrorExtensions;
use sonic_rs::json;

let extensions = GraphQLErrorExtensions {
    code: Some("SOME_ERROR_CODE".to_string()),
    service_name: None,
    affected_path: None,
    extensions: std::collections::HashMap::new(),
};

let error = GraphQLError::from_message_and_extensions("An error occurred", extensions);

assert_eq!(json!(error), json!({
    "message": "An error occurred",
    "extensions": {
        "code": "SOME_ERROR_CODE"
    }
}));

pub fn from_message_and_code<TMessage: Into<String>, TCode: Into<String>>( message: TMessage, code: TCode, ) -> Self

Creates a GraphQLError with the given message and code in extensions. Example:

use hive_router_plan_executor::response::graphql_error::GraphQLError;
use sonic_rs::json;

let error = GraphQLError::from_message_and_code("An error occurred", "SOME_ERROR_CODE");

assert_eq!(json!(error), json!({
    "message": "An error occurred",
    "extensions": {
        "code": "SOME_ERROR_CODE"
    }
}));

pub fn add_subgraph_name<TStr: Into<String>>(self, subgraph_name: TStr) -> Self

Adds subgraph name and error code DOWNSTREAM_SERVICE_ERROR to the extensions. Example:

use hive_router_plan_executor::response::graphql_error::GraphQLError;
use sonic_rs::json;

let error = GraphQLError::from("An error occurred")
    .add_subgraph_name("users");

assert_eq!(json!(error), json!({
    "message": "An error occurred",
    "extensions": {
        "serviceName": "users",
        "code": "DOWNSTREAM_SERVICE_ERROR"
    }
}));

pub fn add_affected_path<TStr: Into<String>>(self, affected_path: TStr) -> Self

Adds affected path to the extensions. Example:

use hive_router_plan_executor::response::graphql_error::GraphQLError;
use sonic_rs::json;

let error = GraphQLError::from("An error occurred")
    .add_affected_path("user.friends[0].name");

assert_eq!(json!(error), json!({
    "message": "An error occurred",
    "extensions": {
        "affectedPath": "user.friends[0].name"
    }
}));

Trait Implementations

impl Clone for GraphQLError

fn clone(&self) -> GraphQLError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphQLError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GraphQLError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&GraphQLError> for ObservedError

fn from(value: &GraphQLError) -> Self

Converts to this type from the input type.

impl From<&ValidationError> for GraphQLError

fn from(val: &ValidationError) -> Self

Converts to this type from the input type.

impl From<&str> for GraphQLError

fn from(message: &str) -> Self

Converts to this type from the input type.

impl From<PlanExecutionError> for GraphQLError

fn from(val: PlanExecutionError) -> Self

Converts to this type from the input type.

impl From<String> for GraphQLError

fn from(message: String) -> Self

Converts to this type from the input type.

impl Serialize for GraphQLError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.