Struct warpgrapher::engine::Engine [−][src]
pub struct Engine<RequestCtx = ()> where
RequestCtx: RequestContext, { /* fields omitted */ }
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,
[src]
impl<RequestCtx> Engine<RequestCtx> where
RequestCtx: RequestContext,
[src]pub fn new(
config: Configuration,
database_pool: <<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType
) -> EngineBuilder<RequestCtx>
[src]
pub fn new(
config: Configuration,
database_pool: <<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType
) -> EngineBuilder<RequestCtx>
[src]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>
[src]
pub async fn execute(
&self,
query: String,
input: Option<Value>,
metadata: HashMap<String, String>
) -> Result<Value, Error>
[src]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,
[src]
impl<RequestCtx: Clone> Clone for Engine<RequestCtx> where
RequestCtx: RequestContext,
[src]impl<RequestCtx> Debug for Engine<RequestCtx> where
RequestCtx: RequestContext,
[src]
impl<RequestCtx> Debug for Engine<RequestCtx> where
RequestCtx: RequestContext,
[src]Auto Trait Implementations
impl<RequestCtx> RefUnwindSafe for Engine<RequestCtx> where
RequestCtx: RefUnwindSafe,
<<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType: RefUnwindSafe,
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,
<<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,
RequestCtx: RefUnwindSafe,
<<RequestCtx as RequestContext>::DBEndpointType as DatabaseEndpoint>::PoolType: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
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>,