Enum minijinja::value::ObjectRepr

#[non_exhaustive]
pub enum ObjectRepr {
    Plain,
    Map,
    Seq,
    Iterable,
}

Defines the natural representation of this object.

An ObjectRepr is a reduced form of ValueKind which only contains value which can be represented by objects. For instance an object can never be a primitive and as such those kinds are unavailable.

The representation influences how values are serialized, stringified or what kind they report.

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.

Plain

An object that has no reasonable representation.

• Default Render: Debug
• Collection Behavior: none
• Iteration Behavior: none
• Serialize: Debug / render output as string

Map

Represents a map or object.

• Default Render: {key: value,...} pairs
• Collection Behavior: looks like a map, can be indexed by key, has a length
• Iteration Behavior: iterates over keys
• Serialize: Serializes as map

Seq

Represents a sequence (eg: array/list).

• Default Render: [value,...]
• Collection Behavior: looks like a list, can be indexed by index, has a length
• Iteration Behavior: iterates over values
• Serialize: Serializes as list

Iterable

Represents a non indexable, iterable object.

• Default Render: [value,...] (if length is known), "<iterator>" otherwise.
• Collection Behavior: looks like a list if length is known, cannot be indexed
• Iteration Behavior: iterates over values
• Serialize: Serializes as list

Trait Implementations

impl Clone for ObjectRepr

fn clone(&self) -> ObjectRepr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectRepr

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

Formats the value using the given formatter.

impl Hash for ObjectRepr

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 Ord for ObjectRepr

fn cmp(&self, other: &ObjectRepr) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ObjectRepr

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ObjectRepr

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for ObjectRepr

impl Eq for ObjectRepr

impl StructuralPartialEq for ObjectRepr