Struct warpgrapher::engine::Engine

pub struct Engine<RequestCtx = ()> where
    RequestCtx: RequestContext,  { /* private fields */ }

A Warpgrapher GraphQL engine.

The Engine struct Juniper GraphQL service on top of it, with an auto-generated set of resolvers that cover basic CRUD operations, and potentially custom resolvers, on a set of data types and the relationships between them. The engine includes handling of back-end communications with the chosen databse.

Examples

let config = Configuration::default();

let mut engine = Engine::<()>::new(config, NoDatabasePool {}).build()?;

Implementations

impl<RequestCtx> Engine<RequestCtx> where
    RequestCtx: RequestContext, 

pub fn new(
    config: Configuration,
    database_pool: <<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType
) -> EngineBuilder<RequestCtx>

Creates a new EngineBuilder. Requiered arguments are a Configuration, the deserialized configuration for a Warpgrapher engine, which contains definitions of types and endpoints, as well as a DatabasePool, which tells the ending how to connect with a back-end graph storage engine.

Examples

let config = Configuration::default();

let mut engine = Engine::<()>::new(config, NoDatabasePool {}).build()?;

pub async fn execute(
    &self,
    query: String,
    input: Option<Value>,
    metadata: HashMap<String, String>
) -> Result<Value, Error>

Executes a GraphQLRequest, returning a serialized JSON response.

Errors

Returns an Error variant ExtensionFailed if a pre request hook or post request hook extension returns an error.

Returns an Error variant SerializationFailed if the engine response cannot be serialized successfully.

Examples

let config = Configuration::default();
let mut engine = Engine::<()>::new(config, NoDatabasePool {}).build()?;

let query = "query { name }".to_string();
let metadata: HashMap<String, String> = HashMap::new();

let result = engine.execute(query, None, metadata).await?;

Trait Implementations

impl<RequestCtx: Clone> Clone for Engine<RequestCtx> where
    RequestCtx: RequestContext, 

fn clone(&self) -> Engine<RequestCtx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<RequestCtx> Debug for Engine<RequestCtx> where
    RequestCtx: RequestContext, 

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

Formats the value using the given formatter.

impl<RequestCtx> Display for Engine<RequestCtx> where
    RequestCtx: RequestContext, 

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

Formats the value using the given formatter.