Struct SystemParameters

#[non_exhaustive]
pub struct SystemParameters {
    pub rules: Vec<SystemParameterRule>,
}

System parameter configuration

A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.

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.

rules: Vec<SystemParameterRule>

Define system parameters.

The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent.

Example: define api key for all methods

system_parameters
  rules:
    - selector: "*"
      parameters:
        - name: api_key
          url_query_parameter: api_key

Example: define 2 api key names for a specific method.

system_parameters
  rules:
    - selector: "/ListShelves"
      parameters:
        - name: api_key
          http_header: Api-Key1
        - name: api_key
          http_header: Api-Key2

NOTE: All service configuration rules follow “last one wins” order.

Implementations

impl SystemParameters

pub fn set_rules<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SystemParameterRule>,

Sets the value of rules.

Trait Implementations

impl Clone for SystemParameters

fn clone(&self) -> SystemParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SystemParameters

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

Formats the value using the given formatter.

impl Default for SystemParameters

fn default() -> SystemParameters

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SystemParameters

where SystemParameters: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SystemParameters

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SystemParameters

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

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 SystemParameters