Interface RequestExt

lambda-http/src/ext/extensions.rs:41–149

Extensions for [`lambda_http::Request`], `http::request::Parts`, and `http::Extensions` structs that provide access to [API gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format) and [ALB](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html) features. [`lamb

///
/// [`lambda_http::Request`]: crate::Request
pub trait RequestExt {
    /// Return the raw http path for a request without any stage information.
    fn raw_http_path(&self) -> &str;

    /// Configures instance with the raw http path.
    fn with_raw_http_path<S>(self, path: S) -> Self
    where
        S: Into<String>;

    /// Return pre-parsed HTTP query string parameters, parameters
    /// provided after the `?` portion of a URL,
    /// associated with the API gateway request.
    ///
    /// The yielded value represents both single and multi-valued
    /// parameters alike. When multiple query string parameters with the same
    /// name are expected, use `query_string_parameters().all("many")` to
    /// retrieve them all.
    ///
    /// Having no query parameters will yield an empty `QueryMap`.
    fn query_string_parameters(&self) -> QueryMap;

    /// Return pre-parsed HTTP query string parameters, parameters
    /// provided after the `?` portion of a URL,
    /// associated with the API gateway request.
    ///
    /// The yielded value represents both single and multi-valued
    /// parameters alike. When multiple query string parameters with the same
    /// name are expected, use
    /// `query_string_parameters_ref().and_then(|params| params.all("many"))` to
    /// retrieve them all.
    ///
    /// Having no query parameters will yield `None`.
    fn query_string_parameters_ref(&self) -> Option<&QueryMap>;

    /// Configures instance with query string parameters
    ///
    /// This is intended for use in mock testing contexts.
    fn with_query_string_parameters<Q>(self, parameters: Q) -> Self
    where
        Q: Into<QueryMap>;

    /// Return pre-extracted path parameters, parameter provided in URL placeholders
    /// `/foo/{bar}/baz/{qux}`,
    /// associated with the API gateway request. Having no path parameters
    /// will yield an empty `QueryMap`.
    ///
    /// These will always be empty for ALB triggered requests.
    fn path_parameters(&self) -> QueryMap;

    /// Return pre-extracted path parameters, parameter provided in URL placeholders
    /// `/foo/{bar}/baz/{qux}`,
    /// associated with the API gateway request. Having no path parameters
    /// will yield `None`.
    ///
    /// These will always be `None` for ALB triggered requests.
    fn path_parameters_ref(&self) -> Option<&QueryMap>;

    /// Configures instance with path parameters