Struct ScopeConfig 

#[non_exhaustive]
pub struct ScopeConfig {
    pub traffic: Option<Vec<Traffic>>,
    pub paths: Vec<String>,
    pub methods: Vec<String>,
}

The traffic a guard covers, and optionally which paths and methods of it.

scope:
  traffic: [transcoded, grpc]   # or [all]
  paths: ["/v1/**", "/acme.v1.Orders/*"]
  methods: ["POST"]

Omitted keys keep the guard’s own default traffic and cover every path and method of it.

Fields (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.

traffic: Option<Vec<Traffic>>

The classes of traffic covered; all names every class.

paths: Vec<String>

Path globs (* within a segment, ** across segments) the guard is narrowed to; empty covers every path. A native gRPC call’s path is /<package>.<Service>/<Method>.

methods: Vec<String>

Methods the guard is narrowed to; empty covers every method. Each is a standard method or one a route answers (a custom rule, an extra route); a scope covering the fallback takes any method token.

Implementations

impl ScopeConfig

pub fn traffic(traffic: impl IntoIterator<Item = Traffic>) -> Self

A scope covering every path and method of traffic.

Examples

use structured_proxy::config::{ScopeConfig, Traffic};

let scope = ScopeConfig::traffic([Traffic::Transcoded, Traffic::Grpc]);
assert!(scope.paths.is_empty());

Trait Implementations

impl Clone for ScopeConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeConfig

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

Formats the value using the given formatter.

impl Default for ScopeConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScopeConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.