Struct Value 

pub struct Value<'a> { /* private fields */ }

One value in a tree.

Implementations

impl<'a> Value<'a>

pub fn tag(&self) -> Option<&'a Tag>

The value’s YAML tag, which in ASDF is what gives it its type.

pub fn has_tag(&self, name: &str) -> bool

Whether the tag names this ASDF schema, ignoring its version.

So has_tag("core/ndarray") matches both core/ndarray-1.0.0 and core/ndarray-1.1.0.

pub fn as_raw_str(&self) -> Option<&'a str>

The raw scalar text, whatever its type.

pub fn as_str(&self) -> Option<&'a str>

The value as a string, if it is one.

A quoted "42" is a string; an unquoted 42 is not.

pub fn as_i64(&self) -> Option<i64>

The value as a signed integer.

pub fn as_u64(&self) -> Option<u64>

The value as an unsigned integer.

pub fn as_f64(&self) -> Option<f64>

The value as a float. Integers convert.

pub fn as_bool(&self) -> Option<bool>

The value as a boolean.

pub fn is_null(&self) -> bool

Whether the value is null.

pub fn is_mapping(&self) -> bool

Whether this is a mapping.

pub fn is_sequence(&self) -> bool

Whether this is a sequence.

pub fn len(&self) -> Option<usize>

The number of children, for a mapping or sequence.

pub fn is_empty(&self) -> Option<bool>

Whether this container has no children.

pub fn get(&self, key: &str) -> Option<Value<'a>>

A mapping entry by key.

pub fn at(&self, index: i64) -> Option<Value<'a>>

A sequence element, with negative indices counting from the end.

pub fn path(&self, path: &str) -> Option<Value<'a>>

A value further down, by path.

pub fn entries(&self) -> impl Iterator<Item = (&'a str, Value<'a>)> + 'a

Iterate a mapping’s entries in document order.

pub fn items(&self) -> impl Iterator<Item = Value<'a>> + 'a

Iterate a sequence’s items.

pub fn as_ndarray(&self) -> Option<Ndarray>

Interpret this value as an ndarray.

Returns None when it is not one; the array’s data is then read through AsdfFile::read_array.

pub fn as_software(&self) -> Option<Software>

Interpret this value as a core/software record.

pub fn as_history_entry(&self) -> Option<HistoryEntry>

Interpret this value as a core/history_entry record.

pub fn as_extension_metadata(&self) -> Option<ExtensionMetadata>

Interpret this value as a core/extension_metadata record.

pub fn as_time(&self) -> Option<Time>

Interpret this value as a time/time.

The schema allows the whole value to be the time string, or a mapping with value, format, scale and a location; both read here, and the calendar breakdown comes with it where the value allows one.

pub fn is_alias(&self) -> bool

Whether this value is an alias to another node.

Trait Implementations

impl<'a> Clone for Value<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Value<'a>

impl<'a> Debug for Value<'a>

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

Formats the value using the given formatter.