Struct ProxyRewriteBuilder

pub struct ProxyRewriteBuilder {
    pub uri: Option<String>,
    pub method: Option<ProxyRewriteMethod>,
    pub regex_uri: Option<Vec<String>>,
    pub host: Option<String>,
    pub use_real_request_uri_unsafe: Option<bool>,
    pub headers: Option<ProxyRewriteHeaders>,
}

Builder pattern to create a ProxyRewrite

Fields

uri: Option<String>

method: Option<ProxyRewriteMethod>

regex_uri: Option<Vec<String>>

host: Option<String>

use_real_request_uri_unsafe: Option<bool>

headers: Option<ProxyRewriteHeaders>

Implementations

impl ProxyRewriteBuilder

pub fn new() -> Self

pub fn with_uri(self, uri: impl Into<String>) -> Self

New Upstream forwarding address. Value supports Nginx variables.

Example, $arg_name

pub fn with_method(self, method: ProxyRewriteMethod) -> Self

Rewrites the HTTP method

pub fn with_regex_uri(self, regex_uri: Vec<String>) -> Self

Regular expressions can be used to match the URL from client. If it matches, the URL template is forwarded to the upstream. Otherwise, the URL from the client is forwarded. When both uri and regex_uri are configured, uri has a higher priority. Multiple regular expressions are currently supported for pattern matching, and the plugin will try to match them one by one until they succeed or all fail.

For example: [“^/iresty/(. *)/(. *)/(. *)”, “/$1-$2-$3”, ^/theothers/(. *)/(. *)“, “/theothers/$1-$2”], the element with the odd index represents the uri regular expression that matches the request from the client, and the element with the even index represents the uri template that is forwarded upstream upon a successful match. Please note that the length of this value must be an even number.

pub fn with_host(self, host: impl Into<String>) -> Self

New Upstream host address

pub fn with_use_real_request_uri_unsafe( self, use_real_request_uri_unsafe: bool, ) -> Self

Use real_request_uri (original $request_uri in nginx) to bypass URI normalization. Enabling this is considered unsafe as it bypasses all URI normalization steps.

pub fn with_headers(self, headers: ProxyRewriteHeaders) -> Self

pub fn build(self) -> Result<ProxyRewrite, ApisixClientError>

Header manipulator

Trait Implementations

impl Clone for ProxyRewriteBuilder

fn clone(&self) -> ProxyRewriteBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProxyRewriteBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProxyRewriteBuilder

fn default() -> ProxyRewriteBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProxyRewriteBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ProxyRewrite> for ProxyRewriteBuilder

fn from(item: ProxyRewrite) -> Self

Converts to this type from the input type.

impl PartialEq for ProxyRewriteBuilder

fn eq(&self, other: &ProxyRewriteBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ProxyRewriteBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProxyRewriteBuilder