glib

Crates.ioglib
lib.rsglib
version0.19.7
sourcesrc
created_at2015-05-12 18:00:50.319378
updated_at2024-05-23 06:22:30.964872
descriptionRust bindings for the GLib library
homepagehttps://gtk-rs.org/
repositoryhttps://github.com/gtk-rs/gtk-rs-core
max_upload_size
id2087
size1,763,083
Bilal Elmoussaoui (bilelmoussaoui)

documentation

https://gtk-rs.org/gtk-rs-core/stable/latest/docs/glib/

README

Rust GLib and GObject bindings

Rust bindings and wrappers for GLib, part of gtk-rs-core.

GLib 2.56 is the lowest supported version for the underlying library.

This library contains bindings to GLib and GObject types and APIs as well as common building blocks used in both handmade and machine generated bindings to GTK and other GLib-based libraries.

It is the foundation for higher level libraries with uniform Rusty (safe and strongly typed) APIs. It avoids exposing GLib-specific data types where possible and is not meant to provide comprehensive GLib bindings, which would often amount to duplicating the Rust Standard Library or other utility crates.

Minimum supported Rust version

Currently, the minimum supported Rust version is 1.70.0.

Dynamic typing

Most types in the GLib family have [Type] identifiers. Their corresponding Rust types implement the [StaticType] trait.

A dynamically typed [Value] can carry values of any [StaticType]. Variants can carry values of [StaticVariantType].

Errors

Errors are represented by [Error], which can carry values from various error domains such as [FileError].

Objects

Each class and interface has a corresponding smart pointer struct representing an instance of that type (e.g. [Object] for GObject or gtk::Widget for GtkWidget). They are reference counted and feature interior mutability similarly to Rust's Rc<RefCell<T>> idiom. Consequently, cloning objects is cheap and their methods never require mutable borrows. Two smart pointers are equal if they point to the same object.

The root of the object hierarchy is [Object]. Inheritance and subtyping is denoted with the [IsA] marker trait. The [Cast] trait enables upcasting and downcasting.

Interfaces and non-leaf classes also have corresponding traits (e.g. [ObjectExt] or gtk::WidgetExt), which are blanketly implemented for all their subtypes.

You can create new subclasses of [Object] or other object types. Look at the module's documentation for further details and a code example.

Under the hood

GLib-based libraries largely operate on pointers to various boxed or reference counted structures so the bindings have to implement corresponding smart pointers (wrappers), which encapsulate resource management and safety checks. Such wrappers are defined via the [wrapper][macro@wrapper] macro, which uses abstractions defined in the [wrapper][mod@wrapper], [boxed][mod@boxed], [shared][mod@shared] and [object][mod@object] modules.

The [translate][mod@translate] module defines and partly implements conversions between high level Rust types (including the aforementioned wrappers) and their FFI counterparts.

Documentation

Using

We recommend using crates from crates.io, as demonstrated here.

If you want to track the bleeding edge, use the git dependency instead:

[dependencies]
glib = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "glib" }

Avoid mixing versioned and git crates like this:

# This will not compile
[dependencies]
glib = "0.13"
glib = { git = "https://github.com/gtk-rs/gtk-rs-core.git", package = "glib" }

License

glib is available under the MIT License, please refer to it.

Commit count: 13593

cargo fmt