Struct over::obj::Obj

pub struct Obj { /* fields omitted */ }

Obj struct.

Methods

impl Obj

fn from_map(obj_map: HashMap<String, Value>) -> OverResult<Obj>

Returns a new Obj created from the given HashMap.

Returns an error if the map contains an invalid field name. A valid field name must start with an alphabetic character or '_' and subsequent characters must be alphabetic, numeric, or '_'.

fn from_map_with_parent(
    obj_map: HashMap<String, Value>,
    parent: Obj
) -> OverResult<Obj>

Returns a new Obj created from the given HashMap with given parent.

Returns an error if the map contains an invalid field name.

See from_map for more details.

fn from_map_unchecked(obj_map: HashMap<String, Value>) -> Obj

Returns a new Obj created from the given HashMap.

It is faster than the safe version, from_map, if you know every field has a valid name. You can check ahead of time whether a field is valid with is_valid_field.

See from_map for more details.

fn from_map_with_parent_unchecked(
    obj_map: HashMap<String, Value>,
    parent: Obj
) -> Obj

Returns a new Obj created from the given HashMap with given parent.

It is faster than the safe version, from_map_with_parent, if you know every field has a valid name. You can check ahead of time whether a field is valid with is_valid_field.

See from_map for more details.

fn to_map(&self) -> HashMap<String, Value>

Returns the map of values in this Obj. Parent field/value pairs are excluded.

fn map_ref(&self) -> &HashMap<String, Value>

Returns a reference to the inner map of this Obj.

fn from_file(path: &str) -> OverResult<Obj>

Returns a new Obj loaded from a file.

fn write_to_file(&self, path: &str) -> OverResult<()>

Writes this Obj to given file in .over representation.

Notes

Note that the fields of the Obj will be output in an unpredictable order. Also note that shorthand in the original file, including variables and file includes, is not preserved when parsing the file, and will not appear when writing to another file.

fn write_str(&self) -> String

Writes this Obj to a String.

Notes

See write_to_file.

fn with_each<F>(&self, f: F) where
    F: FnMut(&String, &Value), 

Iterates over each (String, Value) pair in self, applying f.

fn len(&self) -> usize

Returns the number of fields for this Obj (parent fields not included).

fn is_empty(&self) -> bool

Returns whether this Obj is empty.

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

Returns whether self and other point to the same data.

fn contains(&self, field: &str) -> bool

Returns true if this Obj contains field.

fn get(&self, field: &str) -> Option<Value>

Gets the Value associated with field.

fn get_with_source(&self, field: &str) -> Option<(Value, Obj)>

Gets the Value associated with field and the Obj where it was found (either self or one of its parents).

fn get_bool(&self, field: &str) -> OverResult<bool>

fn get_int(&self, field: &str) -> OverResult<BigInt>

fn get_frac(&self, field: &str) -> OverResult<BigRational>

fn get_char(&self, field: &str) -> OverResult<char>

fn get_str(&self, field: &str) -> OverResult<String>

fn get_arr(&self, field: &str) -> OverResult<Arr>

fn get_tup(&self, field: &str) -> OverResult<Tup>

fn get_obj(&self, field: &str) -> OverResult<Obj>

fn has_parent(&self) -> bool

Returns whether this Obj has a parent.

fn get_parent(&self) -> Option<Obj>

Returns the parent for this Obj.

fn is_valid_field(field: &str) -> bool

Returns true if field is a valid field name for an Obj.

The first character must be alphabetic or '_'. Subsequent characters are allowed to be alphabetic, digits, or '_'.

fn is_valid_field_char(ch: char, first: bool) -> bool

Returns true if the given char is valid for a field, depending on whether it is the first char or not.

See is_valid_field for more details.

Trait Implementations

impl Clone for Obj

fn clone(&self) -> Obj

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Obj

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Obj

fn default() -> Self

Returns the "default value" for a type.

impl Display for Obj

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

Formats the value using the given formatter.

impl FromStr for Obj

type Err = OverError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Obj

For two Objs to be equal, the following two checks must pass: 1. If either Obj has a parent, then both must have parents and the parents must be equal. 2. The two Objs must have all the same fields pointing to the same values.

fn eq(&self, other: &Self) -> 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 !=.

impl PartialEq<Value> for Obj

fn eq(&self, other: &Value) -> 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 !=.