Struct warpgrapher::engine::Engine
source · [−]pub struct Engine<RequestCtx = ()> where
RequestCtx: RequestContext, { /* private fields */ }
Expand description
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
pub fn new(
config: Configuration,
database_pool: <<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType
) -> EngineBuilder<RequestCtx>
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()?;
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
Auto Trait Implementations
impl<RequestCtx> RefUnwindSafe for Engine<RequestCtx> where
RequestCtx: RefUnwindSafe,
<<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType: RefUnwindSafe,
impl<RequestCtx> Unpin for Engine<RequestCtx> where
<<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType: Unpin,
impl<RequestCtx> UnwindSafe for Engine<RequestCtx> where
RequestCtx: RefUnwindSafe,
<<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more