Struct over::obj::Obj

pub struct Obj { /* fields omitted */ }

Obj struct.

Methods

impl Obj

fn new() -> Obj

Returns a new empty 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

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

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

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 (children/parents 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 iff the Obj contains field.

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

Removes a field and its associated value from the Obj.

fn clear(&mut self)

Clears all fields from the Obj.

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 set(&mut self, field: &str, value: Value)

Sets the Value for field.

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 set_parent(&mut self, parent: &Obj) -> OverResult<()>

Sets the parent for this Obj. Circular references in parents are not allowed.

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

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 !=.