Struct Options 

pub struct Options(pub BTreeMap<String, OptionValue>);

The options of one port entry: everything under [source], [stream], or [sinks.<name>] except its type, keyed in sorted order.

Tuple Fields

0: BTreeMap<String, OptionValue>

Implementations

impl Options

pub fn empty() -> Self

An empty options map: the entry’s type with no settings, so every adapter default applies.

pub fn is_empty(&self) -> bool

Whether no option was given.

pub fn get(&self, key: &str) -> Option<&OptionValue>

Read one top-level option.

pub fn insert(&mut self, key: impl Into<String>, value: impl Into<OptionValue>)

Set one top-level option, replacing an existing value. Used by the composition root to lay a flag or environment override over the file.

pub fn deserialize_into<T: DeserializeOwned>(self) -> Result<T, OptionsError>

Turn the tree into an adapter’s typed config. The adapter’s struct decides the strictness (deny_unknown_fields, defaults, required fields); an error names the offending field.

pub fn from_serialize<T: Serialize>(value: &T) -> Result<Self, OptionsError>

Build the tree from any serializable struct, typically an adapter’s config: the reverse of deserialize_into, used to render an adapter’s example and to write a config back out. Fails if the value is not a map at the top level.

Trait Implementations

impl Clone for Options

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 Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Options> for OptionValue

fn from(value: Options) -> Self

Converts to this type from the input type.

impl FromIterator<(String, OptionValue)> for Options

fn from_iter<I: IntoIterator<Item = (String, OptionValue)>>(iter: I) -> Self

Creates a value from an iterator.

impl JsonSchema for Options

An options map is “any table” to the schema: the adapter’s own schema is what constrains it, spliced in by the composition root per type.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

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

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for Options

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Options

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 Options