Skip to main content

Setting

Struct Setting 

Source
pub struct Setting {
    pub name: &'static str,
    pub kind: &'static str,
    pub default: DefaultValue,
    pub levels: &'static [Level],
    pub since: &'static str,
    pub description: &'static str,
    /* private fields */
}
Expand description

One setting.

Fields§

§name: &'static str

The name in kebab-case, without the timelake. prefix.

§kind: &'static str

The kind of value, as the docs show it (boolean, duration, …).

§default: DefaultValue

The value when nothing sets it.

§levels: &'static [Level]

Where it can be set. Empty for properties Timelake manages itself.

§since: &'static str

The Timelake version that added it.

§description: &'static str

What it does, for the docs.

Implementations§

Source§

impl Setting

Source

pub fn property(&self) -> String

The table property: timelake.read-dedup.

Source

pub fn sql_name(&self) -> String

The name in SQL: timelake.read_dedup.

Source

pub fn allows(&self, level: Level) -> bool

Whether the setting can be set at level.

Source

pub fn check(&self, value: &str) -> Result<()>

Errors when value isn’t a valid value of this setting.

Trait Implementations§

Source§

impl Debug for Setting

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.