Struct quilkin::Config

#[non_exhaustive]
pub struct Config {
    pub admin: Slot<Admin>,
    pub clusters: Slot<ClusterMap>,
    pub filters: Slot<FilterChain>,
    pub id: Slot<String>,
    pub management_servers: Slot<Vec<ManagementServer>>,
    pub port: Slot<u16>,
    pub version: Slot<Version>,
    pub maxmind_db: Slot<Source>,
    /* private fields */
}

Config is the configuration of a proxy

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.

admin: Slot<Admin>

clusters: Slot<ClusterMap>

filters: Slot<FilterChain>

id: Slot<String>

management_servers: Slot<Vec<ManagementServer>>

port: Slot<u16>

version: Slot<Version>

maxmind_db: Slot<Source>

Implementations

impl Config

pub fn builder() -> Builder

Returns a new empty Builder for Config.

pub fn from_reader<R: Read>(input: R) -> Result<Self, Error>

Attempts to deserialize input as a YAML object representing Self.

pub fn update_from_json(&self, map: Map<String, Value>) -> Result<(), Error>

pub fn discovery_request(
    &self,
    _node_id: &str,
    resource_type: ResourceType,
    names: &[String]
) -> Result<DiscoveryResponse, Error>

pub fn apply(&self, response: &Resource) -> Result<()>

pub fn apply_metrics(&self)

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Config

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<Config> for Config

fn eq(&self, rhs: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Config

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

Serialize this value into the given Serde serializer.

impl TryFrom<Builder> for Config

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(builder: Builder) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Config> for Proxy

type Error = Report

The type returned in the event of a conversion error.

fn try_from(config: Config) -> Result<Self, Self::Error>

Performs the conversion.