Struct OnHttpRequestHookPayload 

pub struct OnHttpRequestHookPayload<'req> {
    pub router_http_request: WebRequest<DefaultError>,
    pub context: &'req PluginContext,
}

Fields

router_http_request: WebRequest<DefaultError>

The raw incoming HTTP request to the router It includes all the details of the request such as headers, body, etc.

Example:

use hive_router::{
   plugins::hooks::on_http_request::{OnHttpRequestHookPayload, OnHttpRequestHookResult},
};

fn on_http_request<'req>(mut payload: OnHttpRequestHookPayload<'req>) -> OnHttpRequestHookResult<'req> {
    let my_header = payload.router_http_request.headers().get("my-header");
    // do something with the header...
    payload.proceed()
}

context: &'req PluginContext

The context object that can be used to share data across different plugin hooks for the same request. It is unique per request and is dropped after the response is sent.

Learn more about the context data sharing in the docs

Example:

use hive_router::{
    plugins::hooks::{
        on_http_request::{OnHttpRequestHookPayload, OnHttpRequestHookResult},
        on_execute::{OnExecuteStartHookPayload, OnExecuteStartHookResult}    
    },
    plugin_context::PluginContext,
    async_trait::async_trait,
};

struct ContextData {
    greetings: String
}

#[async_trait]
impl RouterPlugin for MyPlugin {
    fn on_http_request<'req>(mut payload: OnHttpRequestHookPayload<'req>) -> OnHttpRequestHookResult<'req> {
        let context_data = ContextData {
           greetings: "Hello from context!".to_string()
        };

       payload.context.insert(context_data);

       payload.proceed()
    }

    async fn on_execute<'exec>(&'exec self, payload: OnExecuteStartHookPayload<'exec>) -> OnExecuteStartHookResult<'exec> {
        let context_data = payload.context.get::<ContextData>().unwrap();
        println!("{}", context_data.greetings); // prints "Hello from context!"
        payload.proceed()
    }
}

Trait Implementations

impl<'req> StartHookPayload<OnHttpResponseHookPayload<'req>, Response> for OnHttpRequestHookPayload<'req>

fn proceed<'exec>(self) -> StartHookResult<'exec, Self, TEndPayload, TResponse>

Continue with the regular flow of the hook This is called in most cases when you don’t short-circuit the hook with a response or an error.

fn end_with_response<'exec>( self, output: TResponse, ) -> StartHookResult<'exec, Self, TEndPayload, TResponse>

End the hook execution and return a response to the client immediately, skipping the rest of the execution flow.

fn end_with_graphql_error<'exec>( self, error: GraphQLError, status_code: StatusCode, ) -> StartHookResult<'exec, Self, TEndPayload, TResponse>

where TResponse: FromGraphQLErrorToResponse,

End the hook execution with a GraphQL error, returning a response with the appropriate error format to the client immediately, skipping the rest of the execution flow.

fn on_end<'exec, F>( self, f: F, ) -> StartHookResult<'exec, Self, TEndPayload, TResponse>

where F: FnOnce(TEndPayload) -> EndHookResult<TEndPayload, TResponse> + Send + 'exec,

Attach a callback to be executed at the end of the hook, allowing you to manipulate the end payload or response. This is useful when you want to execute some logic after the main execution of the hook