Struct warpgrapher::engine::events::EventHandlerBag

source · [−]
pub struct EventHandlerBag<RequestCtx: RequestContext> { /* private fields */ }
Expand description

Collects event handlers for application during query processing.

Examples


fn before_user_create(value: Value, ef: EventFacade<()>) -> BoxFuture<Result<Value, Error>> {
   Box::pin(async move {
      // Normally work would be done here, resulting in some new value.
      Ok(value)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_node_create(vec!["User".to_string()], before_user_create);

Implementations

Creates a new collection of event handlers

Examples

let handlers = EventHandlerBag::<()>::new();

Registers an event handler f to be called before the engine is built

Examples

fn before_engine_build(config: &mut Configuration) -> Result<(), Error> {
    Ok(())
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_engine_build(before_engine_build);

Registers an event handler f to be called before a request is executed.

Examples
type Rctx = ();

fn before_request(
    mut rctx: Rctx,
    mut ef: EventFacade<Rctx>,
    metadata: HashMap<String, String>
) -> BoxFuture<Result<Rctx, warpgrapher::Error>> {
    Box::pin(async move {
        // modify request context
        Ok(rctx)
    })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_request(before_request);

Registers an event handler f to be called after a request is executed.

Examples
type Rctx = ();

fn after_request(
    mut ef: EventFacade<Rctx>,
    output: serde_json::Value,
) -> BoxFuture<'static, Result<serde_json::Value, warpgrapher::Error>> {
    Box::pin(async move {
        // modify output
        Ok(output)
    })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_after_request(after_request);

Registers an event handler f to be called before a node of type type_name is created.

Examples

fn before_user_create(value: Value, ef: EventFacade<()>) -> BoxFuture<Result<Value, Error>> {
   Box::pin(async move {
      // Normally work would be done here, resulting in some new value.
      Ok(value)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_node_create(vec!["User".to_string()], before_user_create);

Registers an event handler f to be called before a rel is created.

Examples

fn before_project_owner_create(value: Value, ef: EventFacade<()>) -> BoxFuture<Result<Value, Error>> {
   Box::pin(async move {
      // Normally work would be done here, resulting in some new value.
      Ok(value)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_rel_create(vec!["ProjectOwner".to_string()],
    before_project_owner_create);

Registers an event handler f to be called after a node of type type_name is created.

Examples

fn after_user_create(nodes: Vec<Node<()>>, ef: EventFacade<()>) -> BoxFuture<Result<Vec<Node<()>>, Error>> {
   Box::pin(async move {
        // Normally work would be done here, resulting in some new value.
        Ok(nodes)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_after_node_create(vec!["User".to_string()], after_user_create);

Registers an event handler f to be called after a rel is created.

Examples

fn after_project_owner_create(rels: Vec<Rel<()>>, ef: EventFacade<()>) ->
  BoxFuture<Result<Vec<Rel<()>>, Error>> {
   Box::pin(async move {
     // Normally work would be done here, resulting in some new value.
     Ok(rels)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_after_rel_create(vec!["ProjectOwner".to_string()], after_project_owner_create);

Registers an event handler f to be called before nodes of type type_name are read.

Examples

fn before_user_read(value_opt: Option<Value>, ef: EventFacade<()>) -> BoxFuture<Result<Option<Value>, Error>> {
   Box::pin(async move {
      // Normally work would be done here, resulting in some new value.
      Ok(value_opt)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_node_read(vec!["User".to_string()], before_user_read);

Registers an event handler f to be called before a rel is read.

Examples

fn before_project_owner_read(value_opt: Option<Value>, ef: EventFacade<()>) -> BoxFuture<Result<Option<Value>, Error>> {
   Box::pin(async move {
       // Normally work would be done here, resulting in some new value.
       Ok(value_opt)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_rel_read(vec!["ProjectOwner".to_string()], before_project_owner_read);

Registers an event handler f to be called after a node of type type_name is read.

Examples

fn after_user_read(nodes: Vec<Node<()>>, ef: EventFacade<()>) -> BoxFuture<Result<Vec<Node<()>>, Error>> {
   Box::pin(async move {
       // Normally work would be done here, resulting in some new value.
       Ok(nodes)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_after_node_read(vec!["User".to_string()], after_user_read);

Registers an event handler f to be called after a rel is read.

Examples

fn after_project_owner_read(rels: Vec<Rel<()>>, ef: EventFacade<()>) ->
  BoxFuture<Result<Vec<Rel<()>>, Error>> {
   Box::pin(async move {
       // Normally work would be done here, resulting in some new value.
       Ok(rels)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_after_rel_read(vec!["ProjectOwner".to_string()], after_project_owner_read);

Registers an event handler f to be called before a node of type type_name is updated.

Examples

fn before_user_update(value: Value, ef: EventFacade<()>) -> BoxFuture<Result<Value, Error>> {
   Box::pin(async move {
       // Normally work would be done here, resulting in some new value.
       Ok(value)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_node_update(vec!["User".to_string()], before_user_update);

Registers an event handler f to be called before a rel is created.

Examples

fn before_project_owner_update(value: Value, ef: EventFacade<()>) -> BoxFuture<Result<Value, Error>> {
   Box::pin(async move {
       // Normally work would be done here, resulting in some new value.
       Ok(value)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_rel_update(vec!["ProjectOwner".to_string()],
    before_project_owner_update);

Registers an event handler f to be called after a node of type type_name is updated.

Examples

fn after_user_update(nodes: Vec<Node<()>>, ef: EventFacade<()>) -> BoxFuture<Result<Vec<Node<()>>, Error>> {
   Box::pin(async move {
       // Normally work would be done here, resulting in some new value.
       Ok(nodes)
   })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_after_node_update(vec!["User".to_string()], after_user_update);

Registers an event handler f to be called after a rel is updated.

Examples

fn after_project_owner_update(rels: Vec<Rel<()>>, ef: EventFacade<()>) ->
  BoxFuture<Result<Vec<Rel<()>>, Error>> {
    Box::pin(async move {
        // Normally work would be done here, resulting in some new value.
        Ok(rels)
    })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_after_rel_update(vec!["ProjectOwnerRel".to_string()],
    after_project_owner_update);

Registers an event handler f to be called before a node of type type_name is deleted.

Examples

fn before_user_delete(value: Value, ef: EventFacade<()>) -> BoxFuture<Result<Value, Error>> {
    Box::pin(async move {
        // Normally work would be done here, resulting in some new value.
        Ok(value)
    })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_node_delete(vec!["User".to_string()], before_user_delete);

Registers an event handler f to be called before a rel is deleted.

Examples

fn before_project_owner_delete(value: Value, ef: EventFacade<()>) -> BoxFuture<Result<Value, Error>> {
    Box::pin(async move {
        // Normally work would be done here, resulting in some new value.
        Ok(value)
    })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_before_rel_delete(vec!["ProjectOwnerRel".to_string()],
    before_project_owner_delete);

Registers an event handler f to be called after a node of type type_name is deleted.

Examples

fn after_user_delete(nodes: Vec<Node<()>>, ef: EventFacade<()>) -> BoxFuture<Result<Vec<Node<()>>, Error>> {
    Box::pin(async move {
        // Normally work would be done here, resulting in some new value.
        Ok(nodes)
    })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_after_node_delete(vec!["User".to_string()], after_user_delete);

Registers an event handler f to be called after a rel is deleted.

Examples

fn after_project_owner_delete(rels: Vec<Rel<()>>, ef: EventFacade<()>) ->
  BoxFuture<Result<Vec<Rel<()>>, Error>> {
    Box::pin(async move {
        // Normally work would be done here, resulting in some new value.
        Ok(rels)
    })
}

let mut handlers = EventHandlerBag::<()>::new();
handlers.register_after_rel_delete(vec!["ProjectOwnerRel".to_string()],
    after_project_owner_delete);

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Returns the “default value” for a type. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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