Struct uclicious::raw::object::ObjectRef

pub struct ObjectRef { /* fields omitted */ }

An immutable reference to UCL Object structure. Provides most of the libUCL interface for interacting with parser results.

Methods

impl 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

Performs the conversion.

impl Borrow<ObjectRef> for Object

fn borrow(&self) -> &ObjectRef

Immutably borrows from an owned value.

impl Debug for ObjectRef

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

Formats the value using the given formatter.

impl Eq for ObjectRef

impl FromObject<ObjectRef> for i64

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for u64

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for ()

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for String

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for PathBuf

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for SocketAddr

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl<T> FromObject<ObjectRef> for Vec<T> where
    T: FromObject<ObjectRef>, 

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl<T> FromObject<ObjectRef> for Option<T> where
    T: FromObject<ObjectRef>, 

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl<T, S> FromObject<ObjectRef> for HashMap<String, T, S> where
    T: FromObject<ObjectRef> + Clone,
    S: BuildHasher + Default, 

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for Duration

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for i32

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for u32

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for i16

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for u16

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for i8

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for u8

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for f64

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl FromObject<ObjectRef> for bool

fn try_from(value: ObjectRef) -> Result<Self, ObjectError>

Performs the conversion.

impl<'data> IntoIterator for &'data ObjectRef

type Item = ObjectRef

The type of the elements being iterated over.

type IntoIter = Iter<'data>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ObjectRef

type Item = ObjectRef

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for ObjectRef

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ObjectRef> for ObjectRef

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ObjectRef> for ObjectRef

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 StructuralEq for ObjectRef

impl ToOwned for ObjectRef

type Owned = Object

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning.