pub struct ErrorPagePlugin {
pages: HashMap<u16, ErrorPage>,
}Expand description
Replaces Context.response.body and content-type when the response was
generated by the gateway (heuristic: Context.errors non-empty) and its
status code has a configured page. All other responses pass through
unchanged. This plugin never fails at execution time.
Fields§
§pages: HashMap<u16, ErrorPage>Implementations§
Source§impl ErrorPagePlugin
impl ErrorPagePlugin
Sourcepub fn from_config(config: &HashMap<String, Value>) -> Result<Self, String>
pub fn from_config(config: &HashMap<String, Value>) -> Result<Self, String>
Builds the plugin from node config.
Accepted keys (all optional; only the configured statuses are
intercepted): error_404, error_500, error_502, error_503 —
each an object with:
body(string, default an APISIX-style HTML page for that status): the replacement response body.content_type(string, defaulttext/html): the replacementcontent-typeheader value.
An error_XXX key set to a non-object, or body/content_type with
a non-string value, fails at config load. Setting a key to an empty
object {} selects the defaults for that status.
type: error-page
config:
error_502:
body: '{"error": "upstream unavailable"}'
content_type: application/json
error_503: {} # default featherbit HTML pageTrait Implementations§
Source§impl Plugin for ErrorPagePlugin
impl Plugin for ErrorPagePlugin
Source§fn plugin_type(&self) -> &str
fn plugin_type(&self) -> &str
Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”).
Source§fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
ctx: Context,
_named_inputs: &'life1 HashMap<String, Value>,
) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
ctx: Context,
_named_inputs: &'life1 HashMap<String, Value>,
) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Executes the plugin logic against the request/response context. Read more
Auto Trait Implementations§
impl Freeze for ErrorPagePlugin
impl RefUnwindSafe for ErrorPagePlugin
impl Send for ErrorPagePlugin
impl Sync for ErrorPagePlugin
impl Unpin for ErrorPagePlugin
impl UnsafeUnpin for ErrorPagePlugin
impl UnwindSafe for ErrorPagePlugin
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more