mochi - v2.0.0

mochi/response

Types

DeferredPatchResponse

</> 
pub type DeferredPatchResponse {
  DeferredPatchResponse(
    path: List(String),
    data: option.Option(dynamic.Dynamic),
    errors: option.Option(List(error.GraphQLError)),
    label: option.Option(String),
    has_next: Bool,
  )
}

Constructors

GraphQLResponse

</>

A complete GraphQL response

pub type GraphQLResponse {
  GraphQLResponse(
    data: option.Option(dynamic.Dynamic),
    errors: option.Option(List(error.GraphQLError)),
    extensions: option.Option(dict.Dict(String, dynamic.Dynamic)),
    has_next: option.Option(Bool),
  )
}

Constructors

IncrementalResponse

</> 
pub type IncrementalResponse {
  IncrementalResponse(
    initial: GraphQLResponse,
    patches: List(DeferredPatchResponse),
  )
}

Constructors

Values

deferred_patch_to_dynamic

</> 
pub fn deferred_patch_to_dynamic(
  patch: DeferredPatchResponse,
) -> dynamic.Dynamic

Serialize an incremental response patch to Dynamic

error_count

</> 
pub fn error_count(response: GraphQLResponse) -> Int

Get error count

execution_error_to_graphql_error

</> 
pub fn execution_error_to_graphql_error(
  err: executor.ExecutionError,
) -> error.GraphQLError

failure

</> 
pub fn failure(
  errors: List(error.GraphQLError),
) -> GraphQLResponse

Create an error-only response

format

</> 
pub fn format(response: GraphQLResponse) -> String

Format response for debugging/logging

from_execution_result

</> 
pub fn from_execution_result(
  result: executor.ExecutionResult,
) -> GraphQLResponse

Create a response from an ExecutionResult

from_execution_result_incremental

</> 
pub fn from_execution_result_incremental(
  result: executor.ExecutionResult,
) -> IncrementalResponse

Build an incremental response from an ExecutionResult that contains deferred patches

has_data

</> 
pub fn has_data(response: GraphQLResponse) -> Bool

Check if response has data

has_errors

</> 
pub fn has_errors(response: GraphQLResponse) -> Bool

Check if response has errors

incremental_envelope_to_dynamic

</> 
pub fn incremental_envelope_to_dynamic(
  patches: List(DeferredPatchResponse),
  has_next: Bool,
) -> dynamic.Dynamic

Serialize an incremental delivery envelope to Dynamic Shape: {“incremental”: […patches], “hasNext”: bool}

is_partial

</> 
pub fn is_partial(response: GraphQLResponse) -> Bool

Check if response is partial (has data and errors)

is_success

</> 
pub fn is_success(response: GraphQLResponse) -> Bool

Check if response is successful (has data, no errors)

partial

</> 
pub fn partial(
  data: dynamic.Dynamic,
  errors: List(error.GraphQLError),
) -> GraphQLResponse

Create a partial response with data and errors

serialize

</> 
pub fn serialize(response: GraphQLResponse) -> dynamic.Dynamic

Serialize response to JSON string (requires external JSON encoder) This returns the Dynamic representation - use with a JSON library

success

</> 
pub fn success(data: dynamic.Dynamic) -> GraphQLResponse

Create a successful response with data

to_dynamic

</> 
pub fn to_dynamic(response: GraphQLResponse) -> dynamic.Dynamic

Convert a GraphQLResponse to a Dynamic representation for JSON serialization

to_json

</> 
pub fn to_json(response: GraphQLResponse) -> String

Convert a GraphQLResponse to a JSON string.

If the response data contains a runtime shape that can’t be encoded as JSON (e.g. a resolver returned a tuple or function), fall back to a spec-compliant error response describing the failure rather than silently emitting null for the offending value.

to_json_pretty

</> 
pub fn to_json_pretty(response: GraphQLResponse) -> String

Convert a GraphQLResponse to a pretty-printed JSON string. Same fallback behaviour as to_json on encoding failure.

with_extension

</> 
pub fn with_extension(
  response: GraphQLResponse,
  key: String,
  value: dynamic.Dynamic,
) -> GraphQLResponse

Add a single extension value

with_extensions

</> 
pub fn with_extensions(
  response: GraphQLResponse,
  extensions: dict.Dict(String, dynamic.Dynamic),
) -> GraphQLResponse

Add extensions to a response

with_tracing

</> 
pub fn with_tracing(
  response: GraphQLResponse,
  start_time: Int,
  end_time: Int,
) -> GraphQLResponse

Add tracing data to response extensions

✨ Search Document