Struct Formatter

pub struct Formatter(/* private fields */);

And instance of a formatter for ${plugin_status_key:**}/__version__.

Implementations

impl Formatter

pub fn plugin_status_key<S: Display>( &mut self, value: S, ) -> Result<&mut Self, FormatSetError>

Methods from Deref<Target = KeFormatter<'static, [Segment<'static>; 1]>>

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 + Send + Sync>>

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 Clone for Formatter

fn clone(&self) -> Formatter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Formatter

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

Formats the value using the given formatter.

impl DerefMut for Formatter

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Deref for Formatter

type Target = KeFormatter<'static, [Segment<'static>; 1]>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.