Struct KeFormatter 

pub struct KeFormatter<'s, Storage>
where
    Storage: IKeFormatStorage<'s>,
{ /* private fields */ }

An active formatter for a KeFormat.

Implementations

impl<'s, Storage> KeFormatter<'s, Storage>

where Storage: IKeFormatStorage<'s>,

pub fn format(&self) -> &KeFormat<'s, Storage>

Access the formatter’s format

pub fn clear(&mut self) -> &mut KeFormatter<'s, Storage>

Clear the formatter of previously set values, without deallocating its internal formatting buffer.

pub fn build(&self) -> Result<OwnedKeyExpr, Box<dyn Error + Sync + Send>>

Build a key-expression according to the format and the currently set values.

This doesn’t clear the formatter of already set values, allowing to reuse the builder and only change a subset of its properties before building a new key-expression again.

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

Access the current value for id.

pub fn set<S>( &mut self, id: &str, value: S, ) -> Result<&mut KeFormatter<'s, Storage>, FormatSetError>

where S: Display,

Set a new value for id using S’s Display formatting.

Errors

If the result of format!("{value}") is neither:

• A valid key expression that is included by the pattern for id
• An empty string, on the condition that id’s pattern is **

Trait Implementations

impl<'s, Storage> Clone for KeFormatter<'s, Storage>

where Storage: Clone + IKeFormatStorage<'s>, <Storage as IKeFormatStorage<'s>>::ValuesStorage<Option<(u32, NonMaxU32)>>: Clone,

fn clone(&self) -> KeFormatter<'s, Storage>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'s, Storage> Debug for KeFormatter<'s, Storage>

where Storage: IKeFormatStorage<'s>,

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

Formats the value using the given formatter.

impl<'s, Storage> TryFrom<&KeFormatter<'s, Storage>> for OwnedKeyExpr

where Storage: IKeFormatStorage<'s>,

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( value: &KeFormatter<'s, Storage>, ) -> Result<OwnedKeyExpr, <OwnedKeyExpr as TryFrom<&KeFormatter<'s, Storage>>>::Error>

Performs the conversion.

impl<'s, Storage> TryFrom<&mut KeFormatter<'s, Storage>> for OwnedKeyExpr

where Storage: IKeFormatStorage<'s>,

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( value: &mut KeFormatter<'s, Storage>, ) -> Result<OwnedKeyExpr, <OwnedKeyExpr as TryFrom<&mut KeFormatter<'s, Storage>>>::Error>

Performs the conversion.