Skip to main content

UrlRewrite

Struct UrlRewrite 

Source
#[non_exhaustive]
pub struct UrlRewrite { pub host_rewrite: Option<String>, pub path_prefix_rewrite: Option<String>, pub path_template_rewrite: Option<String>, /* private fields */ }
Available on crate features region-url-maps or url-maps only.
Expand description

The spec for modifying the path before sending the request to the matched backend service.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§host_rewrite: Option<String>

Before forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite.

The value must be from 1 to 255 characters.

§path_prefix_rewrite: Option<String>

Before forwarding the request to the selected backend service, the matching portion of the request’s path is replaced bypathPrefixRewrite.

The value must be from 1 to 1024 characters.

§path_template_rewrite: Option<String>

If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax.

A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field.

  - -At least one variable must be specified in the path_template_match
  field
  • You can omit variables from the rewritten URL
    • The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=*} or {var=**}.

For example, a path_template_match of /static/{format=} could be rewritten as /static/content/{format} to prefix/content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=} can be rewritten as /content/{format}/{country}/{suffix}.

At least one non-empty routeRules[].matchRules[].path_template_match is required.

Only one of path_prefix_rewrite orpath_template_rewrite may be specified.

Implementations§

Source§

impl UrlRewrite

Source

pub fn new() -> Self

Source

pub fn set_host_rewrite<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of host_rewrite.

§Example
let x = UrlRewrite::new().set_host_rewrite("example");
Source

pub fn set_or_clear_host_rewrite<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of host_rewrite.

§Example
let x = UrlRewrite::new().set_or_clear_host_rewrite(Some("example"));
let x = UrlRewrite::new().set_or_clear_host_rewrite(None::<String>);
Source

pub fn set_path_prefix_rewrite<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of path_prefix_rewrite.

§Example
let x = UrlRewrite::new().set_path_prefix_rewrite("example");
Source

pub fn set_or_clear_path_prefix_rewrite<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of path_prefix_rewrite.

§Example
let x = UrlRewrite::new().set_or_clear_path_prefix_rewrite(Some("example"));
let x = UrlRewrite::new().set_or_clear_path_prefix_rewrite(None::<String>);
Source

pub fn set_path_template_rewrite<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of path_template_rewrite.

§Example
let x = UrlRewrite::new().set_path_template_rewrite("example");
Source

pub fn set_or_clear_path_template_rewrite<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of path_template_rewrite.

§Example
let x = UrlRewrite::new().set_or_clear_path_template_rewrite(Some("example"));
let x = UrlRewrite::new().set_or_clear_path_template_rewrite(None::<String>);

Trait Implementations§

Source§

impl Clone for UrlRewrite

Source§

fn clone(&self) -> UrlRewrite

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UrlRewrite

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for UrlRewrite

Source§

fn default() -> UrlRewrite

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

impl Message for UrlRewrite

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for UrlRewrite

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for UrlRewrite

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,