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
sourceimpl<RequestCtx> Engine<RequestCtx> where
RequestCtx: RequestContext,
impl<RequestCtx> Engine<RequestCtx> where
RequestCtx: RequestContext,
sourcepub 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()?;
sourcepub async fn execute(
&self,
query: String,
input: Option<Value>,
metadata: HashMap<String, String>
) -> Result<Value, Error>
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
sourceimpl<RequestCtx: Clone> Clone for Engine<RequestCtx> where
RequestCtx: RequestContext,
impl<RequestCtx: Clone> Clone for Engine<RequestCtx> where
RequestCtx: RequestContext,
sourceimpl<RequestCtx> Debug for Engine<RequestCtx> where
RequestCtx: RequestContext,
impl<RequestCtx> Debug for Engine<RequestCtx> where
RequestCtx: RequestContext,
Auto Trait Implementations
impl<RequestCtx> RefUnwindSafe for Engine<RequestCtx> where
RequestCtx: RefUnwindSafe,
<<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType: RefUnwindSafe,
impl<RequestCtx> Send for Engine<RequestCtx>
impl<RequestCtx> Sync for Engine<RequestCtx>
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more