Enum ArgValue 

#[non_exhaustive]
pub enum ArgValue {
    Str(Text),
    Int(i64),
    Float(f64),
    Decimal(Text),
    DateTime(Arc<DateTimeValue>),
    Custom(Arc<dyn CustomValue + Send + Sync>),
    Source(Arc<dyn ArgSource>),
    Unset,
}

The call-site core: what tr! builds, and what formats it against a catalog the caller supplies. The call-site core: what tr! builds, and what formats it against a catalog the caller supplies. The call-site core: what tr! builds, and what formats it against a catalog the caller supplies. One positional argument of a call site: owned, 'static and Send + Sync, so a description can sit in a const, cross a thread, or wait in a registry until something renders it.

Every variant is borrowed into one Arg.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Str(Text)

A string.

Int(i64)

An integer.

Float(f64)

A float.

Decimal(Text)

An exact decimal as number-literal text (-12.50, 1e3).

DateTime(Arc<DateTimeValue>)

A date/time.

Custom(Arc<dyn CustomValue + Send + Sync>)

An application value: what carries a measure, a date or a value a custom function downcasts (CustomValue).

Source(Arc<dyn ArgSource>)

A value read at format time (ArgSource).

Unset

No value: the message reports an Unresolved Variable, as the spec requires.

Implementations

impl ArgValue

pub fn decimal(text: impl Into<Text>) -> ArgValue

An exact decimal from its number-literal text. The runtime formats and selects on the digits as written, with no float in between.

pub fn custom<C: CustomValue + Send + Sync + 'static>(value: C) -> ArgValue

An application value.

pub fn source<S: ArgSource + 'static>(source: S) -> ArgValue

A value read at format time (ArgSource).

Trait Implementations

impl Clone for ArgValue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgValue

Every variant as written, but for the two whose value is the application’s own and has no Debug to call: Custom(..), Source(..).

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

Formats the value using the given formatter.

impl From<&OsString> for ArgValue

Available on crate feature host-std, or crate feature native, or (crate features csr or hydrate or ssr) and (crate features leptos-0-8 or leptos) only.

As &PathBuf.

fn from(s: &OsString) -> ArgValue

Converts to this type from the input type.

impl From<&PathBuf> for ArgValue

Available on crate feature host-std, or crate feature native, or (crate features csr or hydrate or ssr) and (crate features leptos-0-8 or leptos) only.

Beside &T for T: IntoArg + Copy, a reference to a type that is not Copy cannot be an IntoArg; tr! takes it through this.

fn from(p: &PathBuf) -> ArgValue

Converts to this type from the input type.

impl From<&String> for ArgValue

fn from(s: &String) -> ArgValue

Converts to this type from the input type.

impl From<&Zoned> for ArgValue

Available on crate feature native only.

As Zoned: Zoned is not Copy, so its reference is not an IntoArg (and would otherwise be taken as its text).

fn from(z: &Zoned) -> ArgValue

Converts to this type from the input type.

impl From<&str> for ArgValue

Any string slice, copied: a call site’s &str is rarely 'static (user.name()), and a description outlives the call. A literal keeps its &'static str through ArgValue::str_static, which is what the macro emits for one.

fn from(s: &str) -> ArgValue

Converts to this type from the input type.

impl<C: CustomValue + Send + Sync + 'static> From<Arc<C>> for ArgValue

fn from(c: Arc<C>) -> ArgValue

Converts to this type from the input type.

impl From<Arc<str>> for ArgValue

fn from(s: Arc<str>) -> ArgValue

Converts to this type from the input type.

impl<T> From<ArcMemo<T>> for ArgValue

where T: Into<ArgValue> + Clone + Send + Sync + 'static,

Available on crate features csr or hydrate or ssr only.

fn from(signal: ArcMemo<T>) -> ArgValue

Converts to this type from the input type.

impl<T> From<ArcReadSignal<T>> for ArgValue

where T: Into<ArgValue> + Clone + Send + Sync + 'static,

Available on crate features csr or hydrate or ssr only.

fn from(signal: ArcReadSignal<T>) -> ArgValue

Converts to this type from the input type.

impl<T> From<ArcRwSignal<T>> for ArgValue

where T: Into<ArgValue> + Clone + Send + Sync + 'static,

Available on crate features csr or hydrate or ssr only.

fn from(signal: ArcRwSignal<T>) -> ArgValue

Converts to this type from the input type.

impl<T> From<ArcSignal<T>> for ArgValue

where T: Into<ArgValue> + Clone + Send + Sync + 'static,

Available on crate features csr or hydrate or ssr only.

fn from(signal: ArcSignal<T>) -> ArgValue

Converts to this type from the input type.

impl From<DateTime<'_>> for ArgValue

fn from(d: DateTime<'_>) -> ArgValue

Converts to this type from the input type.

impl From<DateTimeValue> for ArgValue

fn from(d: DateTimeValue) -> ArgValue

Converts to this type from the input type.

impl<T> From<Memo<T>> for ArgValue

where T: Into<ArgValue> + Clone + Send + Sync + 'static,

Available on crate features csr or hydrate or ssr only.

fn from(signal: Memo<T>) -> ArgValue

Converts to this type from the input type.

impl<T> From<ReadSignal<T>> for ArgValue

where T: Into<ArgValue> + Clone + Send + Sync + 'static,

Available on crate features csr or hydrate or ssr only.

fn from(signal: ReadSignal<T>) -> ArgValue

Converts to this type from the input type.

impl<T> From<RwSignal<T>> for ArgValue

where T: Into<ArgValue> + Clone + Send + Sync + 'static,

Available on crate features csr or hydrate or ssr only.

fn from(signal: RwSignal<T>) -> ArgValue

Converts to this type from the input type.

impl<T> From<Signal<T>> for ArgValue

where T: Into<ArgValue> + Clone + Send + Sync + 'static,

Available on crate features csr or hydrate or ssr only.

fn from(signal: Signal<T>) -> ArgValue

Converts to this type from the input type.

impl From<String> for ArgValue

fn from(s: String) -> ArgValue

Converts to this type from the input type.

impl From<Text> for ArgValue

fn from(t: Text) -> ArgValue

Converts to this type from the input type.

impl From<char> for ArgValue

fn from(c: char) -> ArgValue

Converts to this type from the input type.

impl From<f32> for ArgValue

fn from(x: f32) -> ArgValue

Converts to this type from the input type.

impl From<f64> for ArgValue

fn from(x: f64) -> ArgValue

Converts to this type from the input type.

impl From<i8> for ArgValue

fn from(n: i8) -> ArgValue

Converts to this type from the input type.

impl From<i16> for ArgValue

fn from(n: i16) -> ArgValue

Converts to this type from the input type.

impl From<i32> for ArgValue

fn from(n: i32) -> ArgValue

Converts to this type from the input type.

impl From<i64> for ArgValue

fn from(n: i64) -> ArgValue

Converts to this type from the input type.

impl From<u8> for ArgValue

fn from(n: u8) -> ArgValue

Converts to this type from the input type.

impl From<u16> for ArgValue

fn from(n: u16) -> ArgValue

Converts to this type from the input type.

impl From<u32> for ArgValue

fn from(n: u32) -> ArgValue

Converts to this type from the input type.

impl From<usize> for ArgValue

A count: usize is 32-bit on the client, and no collection a server holds is longer than i64::MAX.

fn from(n: usize) -> ArgValue

Converts to this type from the input type.

impl IntoArg for ArgValue

fn into_arg(self) -> ArgValue

The argument’s value.