Struct StreamConfig 

pub struct StreamConfig {
    pub stream_name: String,
    pub stream_type: String,
    pub config: Value,
}

The config for one Stream of a type advertised by this plugin.

For example this user config:

{
  streams: {
    mystream: {
      type: "mystreamtype",
      options: {
        key: "value",
        num: 3,
      },
      // filters: ...
    },
  },
}

would result in the following StreamConfig:

StreamConfig {
  stream_name: "mystream",
  stream_type: "mystreamtype",
  config: Value::Object(BTreeMap::from([
    ("key", Value::String("value")),
    ("num", Value::Integer(3)),
  ])),
}

Don’t hesitate to take advantage of serde_json::from_value, to deserialize the Value into a Rust struct:

#[derive(Deserialize)]
struct MyStreamOptions {
  key: String,
  num: i64,
}

fn validate_config(stream_config: Value) -> Result<MyStreamOptions, serde_json::Error> {
  serde_json::from_value(stream_config.into())
}

Fields

stream_name: String

stream_type: String

config: Value

Trait Implementations

impl Clone for StreamConfig

fn clone(&self) -> StreamConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for StreamConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.