Trait savefile::Introspect

source ·

pub trait Introspect {
    // Required methods
    fn introspect_value(&self) -> String;
    fn introspect_child<'a>(
        &'a self,
        index: usize
    ) -> Option<Box<dyn IntrospectItem<'a> + 'a>>;

    // Provided method
    fn introspect_len(&self) -> usize { ... }
}

Expand description

Gives the ability to look into an object, inspecting any children (fields).

Required Methods§

source

fn introspect_value(&self) -> String

Returns the value of the object, excluding children, as a string. Exactly what the value returned here is depends on the type. For some types, like a plain array, there isn’t much of a value, the entire information of object resides in the children. For other cases, like a department in an organisation, it might make sense to have the value be the name, and have all the other properties as children.

source

fn introspect_child<'a>( &'a self, index: usize ) -> Option<Box<dyn IntrospectItem<'a> + 'a>>

Returns an the name and &dyn Introspect for the child with the given index, or if no child with that index exists, None. All the children should be indexed consecutively starting at 0 with no gaps, all though there isn’t really anything stopping the user of the trait to have any arbitrary index strategy, consecutive numbering 0, 1, 2, … etc is strongly encouraged.

Provided Methods§

source

fn introspect_len(&self) -> usize

Returns the total number of children. The default implementation calculates this by simply calling introspect_child with higher and higher indexes until it returns None. It gives up if the count reaches 10000. If your type can be bigger and you want to be able to introspect it, override this method.

Trait savefile::IntrospectCopy item path

Required Methods§

fn introspect_value(&self) -> String

fn introspect_child<'a>( &'a self, index: usize ) -> Option<Box<dyn IntrospectItem<'a> + 'a>>

Provided Methods§

fn introspect_len(&self) -> usize

Implementations on Foreign Types§

impl Introspect for bool

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for char

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for f32

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for f64

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for i8

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for i16

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for i32

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for i64

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for i128

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for isize

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for str

fn introspect_value(&self) -> String

fn introspect_child(&self, _index: usize) -> Option<Box<dyn IntrospectItem<'_>>>

impl Introspect for u8

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for u16

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for u32

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for u64

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for u128

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for ()

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for usize

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for String

fn introspect_value(&self) -> String

fn introspect_child(&self, _index: usize) -> Option<Box<dyn IntrospectItem<'_>>>

impl Introspect for Arc<str>

fn introspect_value(&self) -> String

fn introspect_child(&self, _index: usize) -> Option<Box<dyn IntrospectItem<'_>>>

fn introspect_len(&self) -> usize

impl Introspect for AtomicBool

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for AtomicI8

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for AtomicI16

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

impl Introspect for AtomicI32

fn introspect_value(&self) -> String

fn introspect_child( &self, _index: usize ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

Trait savefile::Introspect

impl<K, V: Introspect, S: BuildHasher> Introspect for HashMap<K, V, S>
where K: ToString + Introspect + Eq + Hash,

impl<K, V: Introspect, S: BuildHasher> Introspect for IndexMap<K, V, S>
where K: ToString + Introspect + Eq + Hash,