Struct uclicious::raw::object::Object

pub struct Object { /* private fields */ }

Owned and mutable instance of UCL Object. All methods that do not require mutability should be implemented on ObjectRef instead.

Methods from Deref<Target = ObjectRef>

pub fn as_mut_ptr(&mut self) -> *mut ucl_object_t

Return mutable pointer to inner struct.

pub fn as_ptr(&self) -> *const ucl_object_t

Return const pointer to inner struct.

pub fn deep_copy(&self) -> Object

Perform a deep copy

pub fn is_null(&self) -> bool

Returns true if this object is a null.

pub fn is_object(&self) -> bool

Returns true if this object is an object (think hashmap).

pub fn is_string(&self) -> bool

Returns true if this object is a string.

pub fn is_integer(&self) -> bool

Returns true if this object is an integer.

pub fn is_float(&self) -> bool

Returns true if this object is a float.

pub fn is_boolean(&self) -> bool

Returns true if this object is a boolean type.

pub fn is_array(&self) -> bool

Returns true if this object is an array.

pub fn is_time(&self) -> bool

Returns true if this object is a time/duration.

pub fn priority(&self) -> Priority

Get priority assigned to the object.

pub fn kind(&self) -> ucl_type_t

Get type/kind of given object

pub fn key(&self) -> Option<String>

Get key assigned to the object

pub fn lookup<K: AsRef<str>>(&self, key: K) -> Option<ObjectRef>

Lookup a key within an object with type Object.

pub fn lookup_path<K: AsRef<str>>(&self, path: K) -> Option<ObjectRef>

Perform a nested lookup with dot notation.

pub fn as_string(&self) -> Option<String>

Return string value or None.

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

Return an integer value or None.

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

Return a float number of seconds. Only works if object is time.

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

Return a float value or None. This function also works on time object.

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

Return a boolean value or None.

pub fn as_null(&self) -> Option<()>

Return () or None.

pub fn iter(&self) -> Iter<'_>

Preferred way to construct an iterator. Items returned by this iterator are always ObjectRef.

Trait Implementations

impl AsRef<ObjectRef> for Object

fn as_ref(&self) -> &ObjectRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<ObjectRef> for Object

fn borrow(&self) -> &ObjectRef

Immutably borrows from an owned value.

impl Clone for Object

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Deref for Object

type Target = ObjectRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Object

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for Object

Objects may not actually dropped, but their reference count is decreased.

fn drop(&mut self)

Executes the destructor for this type.

impl From<&str> for Object

fn from(source: &str) -> Self

Converts to this type from the input type.

impl From<bool> for Object

fn from(source: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Object

fn from(source: f64) -> Self

Converts to this type from the input type.

impl From<i64> for Object

fn from(source: i64) -> Self

Converts to this type from the input type.

impl Ord for Object

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Object> for Object

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Object> for Object

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Object

impl StructuralEq for Object