Enum Value

pub enum Value {
    None,
    Auto,
    Bool(bool),
    Int(i64),
    Float(f64),
    Length(Length),
    Angle(Angle),
    Ratio(Ratio),
    Relative(Rel<Length>),
    Fraction(Fr),
    Color(Color),
    Gradient(Gradient),
    Tiling(Tiling),
    Symbol(Symbol),
    Version(Version),
    Str(Str),
    Bytes(Bytes),
    Label(Label),
    Datetime(Datetime),
    Decimal(Decimal),
    Duration(Duration),
    Content(Content),
    Styles(Styles),
    Array(Array),
    Dict(Dict),
    Func(Func),
    Args(Args),
    Type(Type),
    Module(Module),
    Dyn(Dynamic),
}

A computational value.

Variants

None

The value that indicates the absence of a meaningful value.

Auto

A value that indicates some smart default behaviour.

Bool(bool)

A boolean: true, false.

Int(i64)

An integer: 120.

Float(f64)

A floating-point number: 1.2, 10e-4.

Length(Length)

A length: 12pt, 3cm, 1.5em, 1em - 2pt.

Angle(Angle)

An angle: 1.5rad, 90deg.

Ratio(Ratio)

A ratio: 50%.

Relative(Rel<Length>)

A relative length, combination of a ratio and a length: 20% + 5cm.

Fraction(Fr)

A fraction: 1fr.

Color(Color)

A color value: #f79143ff.

Gradient(Gradient)

A gradient value: gradient.linear(...).

Tiling(Tiling)

A tiling fill: tiling(...).

Symbol(Symbol)

A symbol: arrow.l.

Version(Version)

A version.

Str(Str)

A string: "string".

Bytes(Bytes)

Raw bytes.

Label(Label)

A label: <intro>.

Datetime(Datetime)

A datetime

Decimal(Decimal)

A decimal value: decimal("123.4500")

Duration(Duration)

A duration

Content(Content)

A content value: [*Hi* there].

Styles(Styles)

Array(Array)

An array of values: (1, "hi", 12cm).

Dict(Dict)

A dictionary value: (a: 1, b: "hi").

Func(Func)

An executable function.

Args(Args)

Captured arguments to a function.

Type(Type)

A type.

Module(Module)

A module.

Dyn(Dynamic)

A dynamic value.

Implementations

impl Value

pub fn dynamic<T>(any: T) -> Self

where T: Debug + Repr + NativeType + PartialEq + Hash + Sync + Send + 'static,

Create a new dynamic value.

pub fn numeric(pair: (f64, Unit)) -> Self

Create a numeric value from a number with a unit.

pub fn ty(&self) -> Type

The type of this value.

pub fn cast<T: FromValue>(self) -> HintedStrResult<T>

Try to cast the value into a specific type.

pub fn field(&self, field: &str, sink: impl DeprecationSink) -> StrResult<Value>

Try to access a field on the value.

pub fn scope(&self) -> Option<&Scope>

The associated scope, if this is a function, type, or module.

pub fn docs(&self) -> Option<&'static str>

Try to extract documentation for the value.

pub fn display(self) -> Content

Return the display representation of the value.

pub fn spanned(self, span: Span) -> Self

Attach a span to the value, if possible.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Value

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Value

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<Value> for Array

fn extend<T: IntoIterator<Item = Value>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Value> for Array

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl FromValue for Value

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for Value

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for Value

fn into_value(self) -> Value

Cast this type into a value.

impl PartialEq for Value

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Value

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Reflect for Value

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(_: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Value

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Serialize for Value

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.