Enum quilkin::config::ConfigType

pub enum ConfigType {
    Static(Value),
    Dynamic(Any),
}

The configuration of a Filter from either a static or dynamic source.

Variants

Static(Value)

Static configuration from YAML.

Dynamic(Any)

Dynamic configuration from Protobuf.

Implementations

impl ConfigType

pub fn deserialize<TextConfiguration, BinaryConfiguration>(
    self,
    filter_name: &str
) -> Result<(Value, TextConfiguration), Error>where
    BinaryConfiguration: Message + Default,
    TextConfiguration: Serialize + for<'de> Deserialize<'de> + TryFrom<BinaryConfiguration>,
    Error: From<<BinaryConfiguration as TryInto<TextConfiguration>>::Error>,

Deserializes takes two type arguments Static and Dynamic representing the types of a static and dynamic configuration respectively.

If the configuration input is a ConfigType::Static, then it is directly deserialized into the returned Static instance.

Otherwise if the input is a ConfigType::Dynamic then the contained Protobuf data is decoded into a type Dynamic instance, after which the decoded value is converted into the returned Static instance. As a result TryFrom must be implemented from the Dynamic to the Static type.

It returns both the deserialized, as well as, a JSON representation of the provided config. It returns an error if any of the serialization or deserialization steps fail.

Trait Implementations

impl Clone for ConfigType

fn clone(&self) -> ConfigType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigType

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

Deserialize this value from the given Serde deserializer.

impl From<Value> for ConfigType

fn from(value: Value) -> Self

Converts to this type from the input type.

impl JsonSchema for ConfigType

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<ConfigType> for ConfigType

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

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConfigType