Struct RouteRule

pub struct RouteRule {
    pub name: Option<Name>,
    pub matches: Vec<RouteMatch>,
    pub timeouts: Option<RouteTimeouts>,
    pub retry: Option<RouteRetry>,
    pub backends: Vec<BackendRef>,
    /* private fields */
}

A RouteRule contains a set of matches that define which requests it applies to, processing rules, and the final destination(s) for matching traffic.

See the Junction docs for a high level description of how Routes and RouteRules behave.

Ordering Rules

Route rules may be ordered by comparing their maximum matches, breaking ties by comparing their next-highest match. This provides a total ordering on rules. Note that having a sorted list of rules does not mean that the list of all matches across all rules is totally sorted.

This ordering is provided for convenience - clients match rules in the order they’re listed in a Route.

Fields

name: Option<Name>

A human-readable name for this rule.

This name is completely optional, and will only be used in diagnostics to make it easier to debug. Diagnostics that don’t have a name will be referred to by their index in a Route’s list of rules.

matches: Vec<RouteMatch>

A list of match rules applied to an outgoing request. Each match is independent; this rule will be matched if any of the listed matches is satisfied.

If no matches are specified, this Rule matches any outgoing request.

timeouts: Option<RouteTimeouts>

retry: Option<RouteRetry>

How to retry requests. If not specified, requests are not retried.

backends: Vec<BackendRef>

Where the traffic should route if this rule matches.

If no backends are specified, this route becomes a black hole for traffic and all matching requests return an error.

Implementations

impl RouteRule

pub fn to_xds(&self) -> Vec<Route>

Trait Implementations

impl Clone for RouteRule

fn clone(&self) -> RouteRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteRule

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

Formats the value using the given formatter.

impl Default for RouteRule

fn default() -> RouteRule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RouteRule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for RouteRule

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RouteRule

fn eq(&self, other: &RouteRule) -> 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 PartialOrd for RouteRule

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RouteRule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RouteRule

impl StructuralPartialEq for RouteRule