Struct StringFunction 

pub struct StringFunction;

The :string handler.

Trait Implementations

impl Clone for StringFunction

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StringFunction

impl Debug for StringFunction

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

Formats the value using the given formatter.

impl Default for StringFunction

fn default() -> Self

Returns the “default value” for a type.

impl Function for StringFunction

fn resolve<'a>( &self, cx: &FnContext<'_>, operand: Option<&Value<'a>>, _options: &Options<'_, 'a>, errs: &mut dyn ErrorSink, ) -> Option<Value<'a>>

Function resolution (formatting.md): operand resolved — a Value::Fallback when it failed to resolve, so the handler decides (plans/03-runtime.md §2.6) — and options resolved with u:id/u:dir removed. None makes the expression a fallback value; the handler has reported why.

fn format(&self, cx: &FnContext<'_>, value: &Value<'_>, out: &mut dyn Sink)

Writes value’s formatted text.

fn selectable(&self, _value: &Value<'_>) -> bool

Whether value supports selection (formatting.md, “Resolve Selectors”). A value that does not matches only *, with Bad Selector.

fn matches( &self, cx: &FnContext<'_>, value: &Value<'_>, key: &str, _errs: &mut dyn ErrorSink, ) -> bool

Match(value, key); key is NFC. Report e.g. Bad Variant Key through errs.

fn formattable( &self, cx: &FnContext<'_>, value: &Value<'_>, ) -> Result<(), FormatError>

Whether value can be formatted. Err(e): the placeholder is a fallback value and e is reported.

fn format_parts( &self, cx: &FnContext<'_>, value: &Value<'_>, out: &mut dyn SubPartSink, )

Writes value’s formatted sub-parts (none by default).

fn part_kind(&self) -> &'static str

The type of this handler’s expression parts.

fn dir(&self, cx: &FnContext<'_>, value: &Value<'_>) -> Dir

The direction of value’s formatted text (Default Bidi Strategy); Auto = unknown.

fn better_than( &self, cx: &FnContext<'_>, value: &Value<'_>, key1: &str, key2: &str, ) -> bool

BetterThan(value, key1, key2), for two keys that both match.