Struct BaseInfo

pub struct BaseInfo { /* private fields */ }

GIBaseInfo is the common base struct of all other Info structs accessible through the Repository API.

All info structures can be cast to a BaseInfo, for instance:

⚠️ The following code is in C ⚠️

   GIFunctionInfo *function_info = ...;
   GIBaseInfo *info = (GIBaseInfo *) function_info;

Most Repository APIs returning a BaseInfo is actually creating a new struct; in other words, g_base_info_unref() has to be called when done accessing the data.

BaseInfo structuress are normally accessed by calling either [RepositoryExt::find_by_name()][crate::prelude::RepositoryExt::find_by_name()], [RepositoryExt::find_by_gtype()][crate::prelude::RepositoryExt::find_by_gtype()] or [RepositoryExt::info()][crate::prelude::RepositoryExt::info()].

⚠️ The following code is in C ⚠️

GIBaseInfo *button_info =
  g_irepository_find_by_name (NULL, "Gtk", "Button");

// ... use button_info ...

g_base_info_unref (button_info);

Hierarchy

⚠️ The following code is in plain ⚠️

  GIBaseInfo
   +---- GIArgInfo
   +---- GICallableInfo
   +---- GIConstantInfo
   +---- GIFieldInfo
   +---- GIPropertyInfo
   +---- GIRegisteredTypeInfo
   +---- GITypeInfo

Implementations

impl BaseInfo

pub fn as_ptr(&self) -> *mut GIBaseInfo

Return the inner pointer to the underlying C value.

impl BaseInfo

pub fn attribute(&self, name: &str) -> Option<String>

Retrieve an arbitrary attribute associated with this node.

name

a freeform string naming an attribute

Returns

The value of the attribute, or None if no such attribute exists

pub fn container(&self) -> Option<BaseInfo>

Obtain the container of the self. The container is the parent GIBaseInfo. For instance, the parent of a GIFunctionInfo is an GIObjectInfo or GIInterfaceInfo.

Returns

the container

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

Obtain the name of the self. What the name represents depends on the InfoType of the self. For instance for GIFunctionInfo it is the name of the function.

Returns

the name of self or None if it lacks a name.

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

Obtain the namespace of self.

Returns

the namespace

pub fn type_(&self) -> InfoType

Obtain the info type of the GIBaseInfo.

Returns

the info type of self

pub fn typelib(&self) -> Option<Typelib>

Obtain the typelib this self belongs to

Returns

the typelib.

pub fn is_deprecated(&self) -> bool

Obtain whether the self is represents a metadata which is deprecated or not.

Returns

true if deprecated

pub fn iterate_attributes(&self) -> AttributeIter<'_>

Iterate over all attributes associated with this node. The iterator structure is typically stack allocated, and must have its first member initialized to None. Attributes are arbitrary namespaced key–value pairs which can be attached to almost any item. They are intended for use by software higher in the toolchain than bindings, and are distinct from normal GIR annotations.

Both the name and value should be treated as constants and must not be freed.

⚠️ The following code is in C ⚠️

void
print_attributes (GIBaseInfo *info)
{
  GIAttributeIter iter = { 0, };
  char *name;
  char *value;
  while (g_base_info_iterate_attributes (info, &iter, &name, &value))
    {
      g_print ("attribute name: %s value: %s", name, value);
    }
}

iterator

a AttributeIter structure, must be initialized; see below

Returns

true if there are more attributes

name

Returned name, must not be freed

value

Returned name, must not be freed

Trait Implementations

impl Clone for BaseInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BaseInfo

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

Formats the value using the given formatter.

impl Hash for BaseInfo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BaseInfo

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BaseInfo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BaseInfo

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for BaseInfo

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for BaseInfo