json_glib/auto/

object.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir
// from gtk-girs (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi,Array,Node};
use glib::{translate::*};

glib::wrapper! {
    /// `JsonObject` is the representation of the object type inside JSON.
    ///
    /// A `JsonObject` contains [`Node`][crate::Node] "members", which may contain
    /// fundamental types, arrays or other objects; each member of an object is
    /// accessed using a unique string, or "name".
    ///
    /// Since objects can be arbitrarily big, copying them can be expensive; for
    /// this reason they are reference counted. You can control the lifetime of
    /// a `JsonObject` using `Json::Object::ref()` and `Json::Object::unref()`.
    ///
    /// To add or overwrite a member with a given name, use [`set_member()`][Self::set_member()].
    ///
    /// To extract a member with a given name, use [`member()`][Self::member()].
    ///
    /// To retrieve the list of members, use [`members()`][Self::members()].
    ///
    /// To retrieve the size of the object (that is, the number of members it has),
    /// use [`size()`][Self::size()].
    #[derive(Debug, PartialOrd, Ord)]
    pub struct Object(Shared<ffi::JsonObject>);

    match fn {
        ref => |ptr| ffi::json_object_ref(ptr),
        unref => |ptr| ffi::json_object_unref(ptr),
        type_ => || ffi::json_object_get_type(),
    }
}

impl Object {
    /// Creates a new object.
    ///
    /// # Returns
    ///
    /// the newly created object
    #[doc(alias = "json_object_new")]
    pub fn new() -> Object {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::json_object_new())
        }
    }

    /// Retrieves a copy of the value of the given member inside an object.
    /// ## `member_name`
    /// the name of the JSON object member to access
    ///
    /// # Returns
    ///
    /// a copy of the value for the
    ///   requested object member
    #[doc(alias = "json_object_dup_member")]
    pub fn dup_member(&self, member_name: &str) -> Option<Node> {
        unsafe {
            from_glib_full(ffi::json_object_dup_member(self.to_glib_none().0, member_name.to_glib_none().0))
        }
    }

    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "json_object_equal")]
     fn equal(&self, b: &Object) -> bool {
        unsafe {
            from_glib(ffi::json_object_equal(ToGlibPtr::<*mut ffi::JsonObject>::to_glib_none(self).0 as glib::ffi::gconstpointer, ToGlibPtr::<*mut ffi::JsonObject>::to_glib_none(b).0 as glib::ffi::gconstpointer))
        }
    }

    /// Iterates over all members of @self and calls @func on
    /// each one of them.
    ///
    /// It is safe to change the value of a member of the oobject
    /// from within the iterator function, but it is not safe to add or
    /// remove members from the object.
    ///
    /// The order in which the object members are iterated is the
    /// insertion order.
    /// ## `func`
    /// the function to be called on each member
    #[doc(alias = "json_object_foreach_member")]
    pub fn foreach_member<P: FnMut(&Object, &str, &Node)>(&self, func: P) {
        let mut func_data: P = func;
        unsafe extern "C" fn func_func<P: FnMut(&Object, &str, &Node)>(object: *mut ffi::JsonObject, member_name: *const std::ffi::c_char, member_node: *mut ffi::JsonNode, user_data: glib::ffi::gpointer) {
            let object = from_glib_borrow(object);
            let member_name: Borrowed<glib::GString> = from_glib_borrow(member_name);
            let member_node = from_glib_borrow(member_node);
            let callback = user_data as *mut P;
            (*callback)(&object, member_name.as_str(), &member_node)
        }
        let func = Some(func_func::<P> as _);
        let super_callback0: &mut P = &mut func_data;
        unsafe {
            ffi::json_object_foreach_member(self.to_glib_none().0, func, super_callback0 as *mut _ as *mut _);
        }
    }

    /// Convenience function that retrieves the array
    /// stored in @member_name of @self. It is an error to specify a
    /// @member_name which does not exist or which holds a non-`null`, non-array
    /// value.
    ///
    /// If @member_name contains `null`, then this function will return `NULL`.
    ///
    /// See also: [`member()`][Self::member()], [`has_member()`][Self::has_member()]
    /// ## `member_name`
    /// the name of the member
    ///
    /// # Returns
    ///
    /// the array inside the object's member
    #[doc(alias = "json_object_get_array_member")]
    #[doc(alias = "get_array_member")]
    pub fn array_member(&self, member_name: &str) -> Option<Array> {
        unsafe {
            from_glib_none(ffi::json_object_get_array_member(self.to_glib_none().0, member_name.to_glib_none().0))
        }
    }

    /// Convenience function that retrieves the boolean value
    /// stored in @member_name of @self. It is an error to specify a
    /// @member_name which does not exist or which holds a non-scalar,
    /// non-`null` value.
    ///
    /// See also: [`is_boolean_member_with_default()`][Self::is_boolean_member_with_default()],
    ///   [`member()`][Self::member()], [`has_member()`][Self::has_member()]
    /// ## `member_name`
    /// the name of the member
    ///
    /// # Returns
    ///
    /// the boolean value of the object's member
    #[doc(alias = "json_object_get_boolean_member")]
    #[doc(alias = "get_boolean_member")]
    pub fn is_boolean_member(&self, member_name: &str) -> bool {
        unsafe {
            from_glib(ffi::json_object_get_boolean_member(self.to_glib_none().0, member_name.to_glib_none().0))
        }
    }

    /// Convenience function that retrieves the boolean value
    /// stored in @member_name of @self.
    ///
    /// If @member_name does not exist, does not contain a scalar value,
    /// or contains `null`, then @default_value is returned instead. If
    /// @member_name contains a non-boolean, non-`null` scalar value, then
    /// whatever json_node_get_boolean() would return is returned.
    /// ## `member_name`
    /// the name of the @self member
    /// ## `default_value`
    /// the value to return if @member_name is not valid
    ///
    /// # Returns
    ///
    /// the boolean value of the object's member, or the
    ///   given default
    #[cfg(feature = "v1_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
    #[doc(alias = "json_object_get_boolean_member_with_default")]
    #[doc(alias = "get_boolean_member_with_default")]
    pub fn is_boolean_member_with_default(&self, member_name: &str, default_value: bool) -> bool {
        unsafe {
            from_glib(ffi::json_object_get_boolean_member_with_default(self.to_glib_none().0, member_name.to_glib_none().0, default_value.into_glib()))
        }
    }

    /// Convenience function that retrieves the floating point value
    /// stored in @member_name of @self. It is an error to specify a
    /// @member_name which does not exist or which holds a non-scalar,
    /// non-`null` value.
    ///
    /// See also: [`double_member_with_default()`][Self::double_member_with_default()],
    ///   [`member()`][Self::member()], [`has_member()`][Self::has_member()]
    /// ## `member_name`
    /// the name of the member
    ///
    /// # Returns
    ///
    /// the floating point value of the object's member
    #[doc(alias = "json_object_get_double_member")]
    #[doc(alias = "get_double_member")]
    pub fn double_member(&self, member_name: &str) -> f64 {
        unsafe {
            ffi::json_object_get_double_member(self.to_glib_none().0, member_name.to_glib_none().0)
        }
    }

    /// Convenience function that retrieves the floating point value
    /// stored in @member_name of @self.
    ///
    /// If @member_name does not exist, does not contain a scalar value,
    /// or contains `null`, then @default_value is returned instead. If
    /// @member_name contains a non-double, non-`null` scalar value, then
    /// whatever json_node_get_double() would return is returned.
    /// ## `member_name`
    /// the name of the @self member
    /// ## `default_value`
    /// the value to return if @member_name is not valid
    ///
    /// # Returns
    ///
    /// the floating point value of the object's member, or the
    ///   given default
    #[cfg(feature = "v1_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
    #[doc(alias = "json_object_get_double_member_with_default")]
    #[doc(alias = "get_double_member_with_default")]
    pub fn double_member_with_default(&self, member_name: &str, default_value: f64) -> f64 {
        unsafe {
            ffi::json_object_get_double_member_with_default(self.to_glib_none().0, member_name.to_glib_none().0, default_value)
        }
    }

    /// Convenience function that retrieves the integer value
    /// stored in @member_name of @self. It is an error to specify a
    /// @member_name which does not exist or which holds a non-scalar,
    /// non-`null` value.
    ///
    /// See also: [`int_member_with_default()`][Self::int_member_with_default()],
    ///   [`member()`][Self::member()], [`has_member()`][Self::has_member()]
    /// ## `member_name`
    /// the name of the object member
    ///
    /// # Returns
    ///
    /// the integer value of the object's member
    #[doc(alias = "json_object_get_int_member")]
    #[doc(alias = "get_int_member")]
    pub fn int_member(&self, member_name: &str) -> i64 {
        unsafe {
            ffi::json_object_get_int_member(self.to_glib_none().0, member_name.to_glib_none().0)
        }
    }

    /// Convenience function that retrieves the integer value
    /// stored in @member_name of @self.
    ///
    /// If @member_name does not exist, does not contain a scalar value,
    /// or contains `null`, then @default_value is returned instead. If
    /// @member_name contains a non-integer, non-`null` scalar value, then whatever
    /// json_node_get_int() would return is returned.
    /// ## `member_name`
    /// the name of the object member
    /// ## `default_value`
    /// the value to return if @member_name is not valid
    ///
    /// # Returns
    ///
    /// the integer value of the object's member, or the
    ///   given default
    #[cfg(feature = "v1_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
    #[doc(alias = "json_object_get_int_member_with_default")]
    #[doc(alias = "get_int_member_with_default")]
    pub fn int_member_with_default(&self, member_name: &str, default_value: i64) -> i64 {
        unsafe {
            ffi::json_object_get_int_member_with_default(self.to_glib_none().0, member_name.to_glib_none().0, default_value)
        }
    }

    /// Retrieves the value of the given member inside an object.
    /// ## `member_name`
    /// the name of the JSON object member to access
    ///
    /// # Returns
    ///
    /// the value for the
    ///   requested object member
    #[doc(alias = "json_object_get_member")]
    #[doc(alias = "get_member")]
    pub fn member(&self, member_name: &str) -> Option<Node> {
        unsafe {
            from_glib_none(ffi::json_object_get_member(self.to_glib_none().0, member_name.to_glib_none().0))
        }
    }

    /// Retrieves all the names of the members of an object.
    ///
    /// You can obtain the value for each member by iterating the returned list
    /// and calling [`member()`][Self::member()].
    ///
    /// # Returns
    ///
    /// the
    ///   member names of the object
    #[doc(alias = "json_object_get_members")]
    #[doc(alias = "get_members")]
    pub fn members(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::json_object_get_members(self.to_glib_none().0))
        }
    }

    /// Convenience function that checks whether the value
    /// stored in @member_name of @self is null. It is an error to
    /// specify a @member_name which does not exist.
    ///
    /// See also: [`member()`][Self::member()], [`has_member()`][Self::has_member()]
    /// ## `member_name`
    /// the name of the member
    ///
    /// # Returns
    ///
    /// `TRUE` if the value is `null`
    #[doc(alias = "json_object_get_null_member")]
    #[doc(alias = "get_null_member")]
    pub fn is_null_member(&self, member_name: &str) -> bool {
        unsafe {
            from_glib(ffi::json_object_get_null_member(self.to_glib_none().0, member_name.to_glib_none().0))
        }
    }

    /// Convenience function that retrieves the object
    /// stored in @member_name of @self. It is an error to specify a @member_name
    /// which does not exist or which holds a non-`null`, non-object value.
    ///
    /// If @member_name contains `null`, then this function will return `NULL`.
    ///
    /// See also: [`member()`][Self::member()], [`has_member()`][Self::has_member()]
    /// ## `member_name`
    /// the name of the member
    ///
    /// # Returns
    ///
    /// the object inside the object's member
    #[doc(alias = "json_object_get_object_member")]
    #[doc(alias = "get_object_member")]
#[must_use]
    pub fn object_member(&self, member_name: &str) -> Option<Object> {
        unsafe {
            from_glib_none(ffi::json_object_get_object_member(self.to_glib_none().0, member_name.to_glib_none().0))
        }
    }

    /// Retrieves the number of members of a JSON object.
    ///
    /// # Returns
    ///
    /// the number of members
    #[doc(alias = "json_object_get_size")]
    #[doc(alias = "get_size")]
    pub fn size(&self) -> u32 {
        unsafe {
            ffi::json_object_get_size(self.to_glib_none().0)
        }
    }

    /// Convenience function that retrieves the string value
    /// stored in @member_name of @self. It is an error to specify a
    /// @member_name that does not exist or which holds a non-scalar,
    /// non-`null` value.
    ///
    /// See also: [`string_member_with_default()`][Self::string_member_with_default()],
    ///   [`member()`][Self::member()], [`has_member()`][Self::has_member()]
    /// ## `member_name`
    /// the name of the member
    ///
    /// # Returns
    ///
    /// the string value of the object's member
    #[doc(alias = "json_object_get_string_member")]
    #[doc(alias = "get_string_member")]
    pub fn string_member(&self, member_name: &str) -> glib::GString {
        unsafe {
            from_glib_none(ffi::json_object_get_string_member(self.to_glib_none().0, member_name.to_glib_none().0))
        }
    }

    /// Convenience function that retrieves the string value
    /// stored in @member_name of @self.
    ///
    /// If @member_name does not exist, does not contain a scalar value,
    /// or contains `null`, then @default_value is returned instead. If
    /// @member_name contains a non-string, non-`null` scalar value, then
    /// [`None`] is returned.
    /// ## `member_name`
    /// the name of the @self member
    /// ## `default_value`
    /// the value to return if @member_name is not valid
    ///
    /// # Returns
    ///
    /// the string value of the object's member, or the
    ///   given default
    #[cfg(feature = "v1_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
    #[doc(alias = "json_object_get_string_member_with_default")]
    #[doc(alias = "get_string_member_with_default")]
    pub fn string_member_with_default(&self, member_name: &str, default_value: &str) -> glib::GString {
        unsafe {
            from_glib_none(ffi::json_object_get_string_member_with_default(self.to_glib_none().0, member_name.to_glib_none().0, default_value.to_glib_none().0))
        }
    }

    /// Retrieves all the values of the members of an object.
    ///
    /// # Returns
    ///
    /// the
    ///   member values of the object
    #[doc(alias = "json_object_get_values")]
    #[doc(alias = "get_values")]
    pub fn values(&self) -> Vec<Node> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::json_object_get_values(self.to_glib_none().0))
        }
    }

    /// Checks whether @self has a member named @member_name.
    /// ## `member_name`
    /// the name of a JSON object member
    ///
    /// # Returns
    ///
    /// `TRUE` if the JSON object has the requested member
    #[doc(alias = "json_object_has_member")]
    pub fn has_member(&self, member_name: &str) -> bool {
        unsafe {
            from_glib(ffi::json_object_has_member(self.to_glib_none().0, member_name.to_glib_none().0))
        }
    }

    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "json_object_hash")]
     fn hash(&self) -> u32 {
        unsafe {
            ffi::json_object_hash(ToGlibPtr::<*mut ffi::JsonObject>::to_glib_none(self).0 as glib::ffi::gconstpointer)
        }
    }

    /// Checks whether the given object has been marked as immutable by calling
    /// [`seal()`][Self::seal()] on it.
    ///
    /// # Returns
    ///
    /// `TRUE` if the object is immutable
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "json_object_is_immutable")]
    pub fn is_immutable(&self) -> bool {
        unsafe {
            from_glib(ffi::json_object_is_immutable(self.to_glib_none().0))
        }
    }

    /// Removes @member_name from @self, freeing its allocated resources.
    /// ## `member_name`
    /// the name of the member to remove
    #[doc(alias = "json_object_remove_member")]
    pub fn remove_member(&self, member_name: &str) {
        unsafe {
            ffi::json_object_remove_member(self.to_glib_none().0, member_name.to_glib_none().0);
        }
    }

    /// Seals the object, making it immutable to further changes.
    ///
    /// This function will recursively seal all members of the object too.
    ///
    /// If the object is already immutable, this is a no-op.
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "json_object_seal")]
    pub fn seal(&self) {
        unsafe {
            ffi::json_object_seal(self.to_glib_none().0);
        }
    }

    /// Convenience function for setting an object member with an array value.
    ///
    /// See also: [`set_member()`][Self::set_member()], [`Node::take_array()`][crate::Node::take_array()]
    /// ## `member_name`
    /// the name of the member
    /// ## `value`
    /// the value of the member
    #[doc(alias = "json_object_set_array_member")]
    pub fn set_array_member(&self, member_name: &str, value: Array) {
        unsafe {
            ffi::json_object_set_array_member(self.to_glib_none().0, member_name.to_glib_none().0, value.into_glib_ptr());
        }
    }

    /// Convenience function for setting an object member with a boolean value.
    ///
    /// See also: [`set_member()`][Self::set_member()], [`Node::init_boolean()`][crate::Node::init_boolean()]
    /// ## `member_name`
    /// the name of the member
    /// ## `value`
    /// the value of the member
    #[doc(alias = "json_object_set_boolean_member")]
    pub fn set_boolean_member(&self, member_name: &str, value: bool) {
        unsafe {
            ffi::json_object_set_boolean_member(self.to_glib_none().0, member_name.to_glib_none().0, value.into_glib());
        }
    }

    /// Convenience function for setting an object member with a floating point value.
    ///
    /// See also: [`set_member()`][Self::set_member()], [`Node::init_double()`][crate::Node::init_double()]
    /// ## `member_name`
    /// the name of the member
    /// ## `value`
    /// the value of the member
    #[doc(alias = "json_object_set_double_member")]
    pub fn set_double_member(&self, member_name: &str, value: f64) {
        unsafe {
            ffi::json_object_set_double_member(self.to_glib_none().0, member_name.to_glib_none().0, value);
        }
    }

    /// Convenience function for setting an object member with an integer value.
    ///
    /// See also: [`set_member()`][Self::set_member()], [`Node::init_int()`][crate::Node::init_int()]
    /// ## `member_name`
    /// the name of the member
    /// ## `value`
    /// the value of the member
    #[doc(alias = "json_object_set_int_member")]
    pub fn set_int_member(&self, member_name: &str, value: i64) {
        unsafe {
            ffi::json_object_set_int_member(self.to_glib_none().0, member_name.to_glib_none().0, value);
        }
    }

    /// Sets the value of a member inside an object.
    ///
    /// If the object does not have a member with the given name, a new member
    /// is created.
    ///
    /// If the object already has a member with the given name, the current
    /// value is overwritten with the new.
    /// ## `member_name`
    /// the name of the member
    /// ## `node`
    /// the value of the member
    #[doc(alias = "json_object_set_member")]
    pub fn set_member(&self, member_name: &str, node: Node) {
        unsafe {
            ffi::json_object_set_member(self.to_glib_none().0, member_name.to_glib_none().0, node.into_glib_ptr());
        }
    }

    /// Convenience function for setting an object member with a `null` value.
    ///
    /// See also: [`set_member()`][Self::set_member()], [`Node::init_null()`][crate::Node::init_null()]
    /// ## `member_name`
    /// the name of the member
    #[doc(alias = "json_object_set_null_member")]
    pub fn set_null_member(&self, member_name: &str) {
        unsafe {
            ffi::json_object_set_null_member(self.to_glib_none().0, member_name.to_glib_none().0);
        }
    }

    /// Convenience function for setting an object member with an object value.
    ///
    /// See also: [`set_member()`][Self::set_member()], [`Node::take_object()`][crate::Node::take_object()]
    /// ## `member_name`
    /// the name of the member
    /// ## `value`
    /// the value of the member
    #[doc(alias = "json_object_set_object_member")]
    pub fn set_object_member(&self, member_name: &str, value: Object) {
        unsafe {
            ffi::json_object_set_object_member(self.to_glib_none().0, member_name.to_glib_none().0, value.into_glib_ptr());
        }
    }

    /// Convenience function for setting an object member with a string value.
    ///
    /// See also: [`set_member()`][Self::set_member()], [`Node::init_string()`][crate::Node::init_string()]
    /// ## `member_name`
    /// the name of the member
    /// ## `value`
    /// the value of the member
    #[doc(alias = "json_object_set_string_member")]
    pub fn set_string_member(&self, member_name: &str, value: &str) {
        unsafe {
            ffi::json_object_set_string_member(self.to_glib_none().0, member_name.to_glib_none().0, value.to_glib_none().0);
        }
    }
}

impl Default for Object {
                     fn default() -> Self {
                         Self::new()
                     }
                 }

#[cfg(feature = "v1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
impl PartialEq for Object {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.equal(other)
    }
}
#[cfg(feature = "v1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]

impl Eq for Object {}

#[cfg(feature = "v1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
impl std::hash::Hash for Object {
    #[inline]
    fn hash<H>(&self, state: &mut H) where H: std::hash::Hasher {
        std::hash::Hash::hash(&self.hash(), state)
    }
}