Struct AdapterDescription 

pub struct AdapterDescription {
    pub port: Port,
    pub kind: String,
    pub schema: AdapterSchema,
    pub example: Options,
    pub secrets: Vec<String>,
    pub index_schema: Option<AdapterSchema>,
}

The rendered facts about one adapter’s options: the JSON schema (draft-07; doc comments as descriptions, serde defaults as defaults), an example, and the field paths that accept an override variable.

Fields

port: Port

Which port the adapter implements.

kind: String

The adapter’s type token.

schema: AdapterSchema

The JSON schema of the options struct.

example: Options

A complete example, as it would appear under the entry.

secrets: Vec<String>

The Secret fields, as .-joined paths from the entry root.

index_schema: Option<AdapterSchema>

The schema of the options the adapter takes per index (an [[index]] entry’s sinks.<name> table), or None when it takes none.

Implementations

impl AdapterDescription

pub fn override_vars<'a>( &'a self, entry: &'a str, ) -> impl Iterator<Item = String> + 'a

The override variable of every secret field for the entry named entry (a sink’s name, or source/stream for the singletons).

Trait Implementations

impl Clone for AdapterDescription

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 AdapterDescription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AdapterDescription

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AdapterDescription

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

where __S: Serializer,

Serialize this value into the given Serde serializer.