Trait Valuable

Source

pub trait Valuable {
    // Required methods
    fn as_value(&self) -> Value<'_>;
    fn visit(&self, visit: &mut dyn Visit);

    // Provided method
    fn visit_slice(slice: &[Self], visit: &mut dyn Visit)
       where Self: Sized { ... }
}

Expand description

A type that can be converted to a Value.

Valuable types are inspected by defining a Visit implementation and using it when calling Valuable::visit. See Visit documentation for more details.

The Valuable procedural macro makes implementing Valuable easy. Users can add add #[derive(Valuable)] to their types.

Valuable provides implementations for many Rust primitives and standard library types.

Types implementing Valuable may also implement one of the more specific traits: Structable, Enumerable, Listable, and Mappable. These traits should be implemented when the type is a nested container of other Valuable types.

Required Methods§

Source

fn as_value(&self) -> Value<'_>

Converts self into a Value instance.

§Examples

use valuable::Valuable;

let _ = "hello".as_value();

Source

fn visit(&self, visit: &mut dyn Visit)

Calls the relevant method on Visit to extract data from self.

This method is used to extract type-specific data from the value and is intended to be an implementation detail. For example, Vec implements visit by calling visit_value() on each of its elements. Structs implement visit by calling visit_named_fields() or visit_unnamed_fields().

Usually, users will call the visit function instead.

Provided Methods§

Source

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)
where Self: Sized,

Calls Visit::visit_primitive_slice() with self.

This method is an implementation detail used to optimize visiting primitive slices.

Trait Valuable Copy item path

Required Methods§

fn as_value(&self) -> Value<'_>

§Examples

fn visit(&self, visit: &mut dyn Visit)

Provided Methods§

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)where Self: Sized,

Trait Implementations§

impl Debug for dyn Valuable + '_

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

Implementations on Foreign Types§

impl Valuable for &str

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[&str], visit: &mut dyn Visit)where &str: Sized,

impl Valuable for &Path

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

impl Valuable for bool

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[bool], visit: &mut dyn Visit)where bool: Sized,

impl Valuable for char

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[char], visit: &mut dyn Visit)where char: Sized,

impl Valuable for f32

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[f32], visit: &mut dyn Visit)where f32: Sized,

impl Valuable for f64

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[f64], visit: &mut dyn Visit)where f64: Sized,

impl Valuable for i8

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[i8], visit: &mut dyn Visit)where i8: Sized,

impl Valuable for i16

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[i16], visit: &mut dyn Visit)where i16: Sized,

impl Valuable for i32

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[i32], visit: &mut dyn Visit)where i32: Sized,

impl Valuable for i64

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[i64], visit: &mut dyn Visit)where i64: Sized,

impl Valuable for i128

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[i128], visit: &mut dyn Visit)where i128: Sized,

impl Valuable for isize

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[isize], visit: &mut dyn Visit)where isize: Sized,

impl Valuable for u8

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[u8], visit: &mut dyn Visit)where u8: Sized,

impl Valuable for u16

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[u16], visit: &mut dyn Visit)where u16: Sized,

impl Valuable for u32

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[u32], visit: &mut dyn Visit)where u32: Sized,

impl Valuable for u64

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[u64], visit: &mut dyn Visit)where u64: Sized,

impl Valuable for u128

fn as_value(&self) -> Value<'_>

fn visit(&self, visit: &mut dyn Visit)

fn visit_slice(slice: &[u128], visit: &mut dyn Visit)where u128: Sized,

impl Valuable for ()

fn as_value(&self) -> Value<'_>

Trait Valuable

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)
where Self: Sized,

fn visit_slice(slice: &[&str], visit: &mut dyn Visit)
where &str: Sized,

fn visit_slice(slice: &[bool], visit: &mut dyn Visit)
where bool: Sized,

fn visit_slice(slice: &[char], visit: &mut dyn Visit)
where char: Sized,

fn visit_slice(slice: &[f32], visit: &mut dyn Visit)
where f32: Sized,

fn visit_slice(slice: &[f64], visit: &mut dyn Visit)
where f64: Sized,

fn visit_slice(slice: &[i8], visit: &mut dyn Visit)
where i8: Sized,

fn visit_slice(slice: &[i16], visit: &mut dyn Visit)
where i16: Sized,

fn visit_slice(slice: &[i32], visit: &mut dyn Visit)
where i32: Sized,

fn visit_slice(slice: &[i64], visit: &mut dyn Visit)
where i64: Sized,

fn visit_slice(slice: &[i128], visit: &mut dyn Visit)
where i128: Sized,

fn visit_slice(slice: &[isize], visit: &mut dyn Visit)
where isize: Sized,

fn visit_slice(slice: &[u8], visit: &mut dyn Visit)
where u8: Sized,

fn visit_slice(slice: &[u16], visit: &mut dyn Visit)
where u16: Sized,

fn visit_slice(slice: &[u32], visit: &mut dyn Visit)
where u32: Sized,

fn visit_slice(slice: &[u64], visit: &mut dyn Visit)
where u64: Sized,

fn visit_slice(slice: &[u128], visit: &mut dyn Visit)
where u128: Sized,

fn visit_slice(slice: &[usize], visit: &mut dyn Visit)
where usize: Sized,

fn visit_slice(slice: &[String], visit: &mut dyn Visit)
where String: Sized,