Trait KnobValue 

pub trait KnobValue:
    Sized
    + Clone
    + Send
    + Sync
    + 'static {
    const TYPE_NAME: &'static str;

    // Required methods
    fn parse_knob(s: &str) -> Option<Self>;
    fn render_knob(&self) -> String;
}

A type usable as a knob value: parseable from the string sources (env / API) and renderable for listing.

Required Associated Constants

const TYPE_NAME: &'static str

Required Methods

fn parse_knob(s: &str) -> Option<Self>

Parse from a source string. None means “unset/invalid”: the resolver falls through to the next source rather than overriding with garbage.

fn render_knob(&self) -> String

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl KnobValue for bool

const TYPE_NAME: &'static str = "bool"

fn parse_knob(s: &str) -> Option<bool>

fn render_knob(&self) -> String

impl KnobValue for f32

const TYPE_NAME: &'static str = "f32"

fn parse_knob(s: &str) -> Option<f32>

fn render_knob(&self) -> String

impl KnobValue for i64

const TYPE_NAME: &'static str = "i64"

fn parse_knob(s: &str) -> Option<i64>

fn render_knob(&self) -> String

impl KnobValue for usize

const TYPE_NAME: &'static str = "usize"

fn parse_knob(s: &str) -> Option<usize>

fn render_knob(&self) -> String

impl<T> KnobValue for Option<T>

where T: KnobValue,

Optional knob: None is the unset/default state (e.g. “autodetect”), Some is an explicit override. A source string that does not parse as T is treated as unset, so the resolver falls through to the next source.

const TYPE_NAME: &'static str = "option"

fn parse_knob(s: &str) -> Option<Option<T>>

fn render_knob(&self) -> String

Implementors

impl KnobValue for String

const TYPE_NAME: &'static str = "string"