libappstream/auto/
content_rating.rs

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

use crate::{ffi, ContentRatingValue};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    ///
    ///
    /// # Implements
    ///
    /// [`ContentRatingExt`][trait@crate::prelude::ContentRatingExt]
    #[doc(alias = "AsContentRating")]
    pub struct ContentRating(Object<ffi::AsContentRating, ffi::AsContentRatingClass>);

    match fn {
        type_ => || ffi::as_content_rating_get_type(),
    }
}

impl ContentRating {
    pub const NONE: Option<&'static ContentRating> = None;

    /// Creates a new [`ContentRating`][crate::ContentRating].
    ///
    /// # Returns
    ///
    /// a [`ContentRating`][crate::ContentRating]
    #[doc(alias = "as_content_rating_new")]
    pub fn new() -> ContentRating {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::as_content_rating_new()) }
    }

    /// Gets the highest [`ContentRatingValue`][crate::ContentRatingValue] which is allowed to be seen by the
    /// given Common Sense Media `age` for the given subsection `id`.
    ///
    /// For example, if the CSM age mappings for `violence-bloodshed` are:
    ///  * age ≥ 0 for [`ContentRatingValue::None`][crate::ContentRatingValue::None]
    ///  * age ≥ 9 for [`ContentRatingValue::Mild`][crate::ContentRatingValue::Mild]
    ///  * age ≥ 11 for [`ContentRatingValue::Moderate`][crate::ContentRatingValue::Moderate]
    ///  * age ≥ 18 for [`ContentRatingValue::Intense`][crate::ContentRatingValue::Intense]
    /// then calling this function with `violence-bloodshed` and `age` set to 17 would
    /// return [`ContentRatingValue::Moderate`][crate::ContentRatingValue::Moderate]. Calling it with age 18 would
    /// return [`ContentRatingValue::Intense`][crate::ContentRatingValue::Intense].
    /// ## `id`
    /// the subsection ID e.g. `violence-cartoon`
    /// ## `age`
    /// the CSM age
    ///
    /// # Returns
    ///
    /// the [`ContentRatingValue`][crate::ContentRatingValue], or [`ContentRatingValue::Unknown`][crate::ContentRatingValue::Unknown] if
    ///  unknown
    #[doc(alias = "as_content_rating_attribute_from_csm_age")]
    pub fn attribute_from_csm_age(id: &str, age: u32) -> ContentRatingValue {
        assert_initialized_main_thread!();
        unsafe {
            from_glib(ffi::as_content_rating_attribute_from_csm_age(
                id.to_glib_none().0,
                age,
            ))
        }
    }

    /// Get a human-readable description of what content would be expected to
    /// require the content rating attribute given by `id` and `value`.
    /// ## `id`
    /// the subsection ID e.g. `violence-cartoon`
    /// ## `value`
    /// the [`ContentRatingValue`][crate::ContentRatingValue], e.g. [`ContentRatingValue::Intense`][crate::ContentRatingValue::Intense]
    ///
    /// # Returns
    ///
    /// a human-readable description of `id` and `value`
    #[doc(alias = "as_content_rating_attribute_get_description")]
    pub fn attribute_get_description(id: &str, value: ContentRatingValue) -> Option<glib::GString> {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(ffi::as_content_rating_attribute_get_description(
                id.to_glib_none().0,
                value.into_glib(),
            ))
        }
    }

    /// Gets the Common Sense Media approved age for a specific rating level.
    /// ## `id`
    /// the subsection ID e.g. `violence-cartoon`
    /// ## `value`
    /// the [`ContentRatingValue`][crate::ContentRatingValue], e.g. [`ContentRatingValue::Intense`][crate::ContentRatingValue::Intense]
    ///
    /// # Returns
    ///
    /// The age in years, or 0 for no details.
    #[doc(alias = "as_content_rating_attribute_to_csm_age")]
    pub fn attribute_to_csm_age(id: &str, value: ContentRatingValue) -> u32 {
        assert_initialized_main_thread!();
        unsafe {
            ffi::as_content_rating_attribute_to_csm_age(id.to_glib_none().0, value.into_glib())
        }
    }

    /// Returns a list of all the valid OARS content rating attribute IDs as could
    /// be passed to [`ContentRatingExt::add_attribute()`][crate::prelude::ContentRatingExt::add_attribute()] or
    /// [`attribute_to_csm_age()`][Self::attribute_to_csm_age()].
    ///
    /// # Returns
    ///
    /// a [`None`]-terminated
    ///  array of IDs, to be freed with `g_free()` (the element values are owned by
    ///  libappstream and must not be freed)
    #[doc(alias = "as_content_rating_get_all_rating_ids")]
    #[doc(alias = "get_all_rating_ids")]
    pub fn all_rating_ids() -> Vec<glib::GString> {
        assert_initialized_main_thread!();
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::as_content_rating_get_all_rating_ids())
        }
    }
}

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

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::ContentRating>> Sealed for T {}
}

/// Trait containing all [`struct@ContentRating`] methods.
///
/// # Implementors
///
/// [`ContentRating`][struct@crate::ContentRating]
pub trait ContentRatingExt: IsA<ContentRating> + sealed::Sealed + 'static {
    /// Adds an attribute value to the content rating.
    /// ## `id`
    /// a content rating ID, e.g. `money-gambling`.
    /// ## `value`
    /// a [`ContentRatingValue`][crate::ContentRatingValue], e.g. [`ContentRatingValue::Moderate`][crate::ContentRatingValue::Moderate].
    #[doc(alias = "as_content_rating_add_attribute")]
    fn add_attribute(&self, id: &str, value: ContentRatingValue) {
        unsafe {
            ffi::as_content_rating_add_attribute(
                self.as_ref().to_glib_none().0,
                id.to_glib_none().0,
                value.into_glib(),
            );
        }
    }

    /// Gets the content_rating kind.
    ///
    /// # Returns
    ///
    /// a string, e.g. "oars-1.0", or NULL
    #[doc(alias = "as_content_rating_get_kind")]
    #[doc(alias = "get_kind")]
    fn kind(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::as_content_rating_get_kind(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the lowest Common Sense Media approved age for the content_rating block.
    /// NOTE: these numbers are based on the data and descriptions available from
    /// https://www.commonsensemedia.org/about-us/our-mission/about-our-ratings and
    /// you may disagree with them.
    ///
    /// You're free to disagree with these, and of course you should use your own
    /// brain to work our if your child is able to cope with the concepts enumerated
    /// here. Some 13 year olds may be fine with the concept of mutilation of body
    /// parts; others may get nightmares.
    ///
    /// # Returns
    ///
    /// The age in years, 0 for no rating, or G_MAXUINT for no details.
    #[doc(alias = "as_content_rating_get_minimum_age")]
    #[doc(alias = "get_minimum_age")]
    fn minimum_age(&self) -> u32 {
        unsafe { ffi::as_content_rating_get_minimum_age(self.as_ref().to_glib_none().0) }
    }

    /// Gets the set of ratings IDs which are present in this `self`. An
    /// example of a ratings ID is `violence-bloodshed`.
    ///
    /// The IDs are returned in lexicographical order.
    ///
    /// # Returns
    ///
    /// [`None`]-terminated
    ///  array of ratings IDs; each ratings ID is owned by the [`ContentRating`][crate::ContentRating] and
    ///  must not be freed, but the container must be freed with `g_free()`
    #[doc(alias = "as_content_rating_get_rating_ids")]
    #[doc(alias = "get_rating_ids")]
    fn rating_ids(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::as_content_rating_get_rating_ids(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the value of a content rating key.
    /// ## `id`
    /// A ratings ID, e.g. `violence-bloodshed`.
    ///
    /// # Returns
    ///
    /// the [`ContentRatingValue`][crate::ContentRatingValue], or [`ContentRatingValue::Unknown`][crate::ContentRatingValue::Unknown]
    #[doc(alias = "as_content_rating_get_value")]
    #[doc(alias = "get_value")]
    fn value(&self, id: &str) -> ContentRatingValue {
        unsafe {
            from_glib(ffi::as_content_rating_get_value(
                self.as_ref().to_glib_none().0,
                id.to_glib_none().0,
            ))
        }
    }

    /// Sets the content rating kind.
    /// ## `kind`
    /// the rating kind, e.g. "oars-1.0"
    #[doc(alias = "as_content_rating_set_kind")]
    fn set_kind(&self, kind: &str) {
        unsafe {
            ffi::as_content_rating_set_kind(self.as_ref().to_glib_none().0, kind.to_glib_none().0);
        }
    }

    /// Sets the value of a content rating key.
    /// ## `id`
    /// A ratings ID, e.g. `violence-bloodshed`.
    /// ## `value`
    /// A [`ContentRatingValue`][crate::ContentRatingValue], e.g. [`ContentRatingValue::Intense`][crate::ContentRatingValue::Intense]
    #[doc(alias = "as_content_rating_set_value")]
    fn set_value(&self, id: &str, value: ContentRatingValue) {
        unsafe {
            ffi::as_content_rating_set_value(
                self.as_ref().to_glib_none().0,
                id.to_glib_none().0,
                value.into_glib(),
            );
        }
    }
}

impl<O: IsA<ContentRating>> ContentRatingExt for O {}
libappstream/auto/content_rating.rs

libappstream/auto/
content_rating.rs
