Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gtk-rs/gtk-rs-core

Rust bindings for GNOME libraries
https://github.com/gtk-rs/gtk-rs-core

cairo gdk-pixbuf gio glib graphene gtk-rs pango pangocairo

Last synced: 3 days ago
JSON representation

Rust bindings for GNOME libraries

Awesome Lists containing this project

README 

        
# gtk-rs-core ![CI](https://github.com/gtk-rs/gtk-rs-core/workflows/CI/badge.svg)



The `gtk-rs` organization aims to provide safe Rust binding over `GObject`-based libraries.

You can find more about it on .



This repository contains all the "core" crates of the gtk-rs organization. For more

information about each crate, please refer to their `README.md` file in their directory.



## Minimum supported Rust version



Currently, the minimum supported Rust version is `1.70.0`.



## Documentation



- [Examples](examples)

- The Rust API [Stable](https://gtk-rs.org/gtk-rs-core/stable/latest/docs/) / [Development](https://gtk-rs.org/gtk-rs-core/git/docs/)



## Ecosystem



The `gtk-rs-core` repository contains Rust crates for the foundational `GObject`-based

libraries. However there is a large ecosystem of `GObject` libraries and many of these

libraries have Rust bindings based on the tooling included in `gtk-rs`.

Of particular note:



 * [gtk3-rs](https://github.com/gtk-rs/gtk3-rs) - bindings for GTK 3

 * [gtk4-rs](https://github.com/gtk-rs/gtk4-rs) - bindings for GTK 4

 * [gstreamer-rs](https://gitlab.freedesktop.org/gstreamer/gstreamer-rs) - bindings for the GStreamer media framework



Additionally, Rust bindings for various libraries are hosted on

[GNOME's GitLab](https://gitlab.gnome.org) instance and can be found at

.



When using crates that are not part of the `gtk-rs` repository, you will

need to be careful and ensure that they do not pull in incompatible versions of core

crates like `glib-rs`.



## Regenerating



To regenerate crates using [gir], please use the `generator.py` file as follows:



```bash

$ python3 generator.py

```



If you didn't do so yet, please check out all the submodules before via



```bash

$ git submodule update --checkout

```



## Development



This repository is mostly split into two branches: `master` and `crate`.

`master` contains the not yet released code and is where new developments

are happening. `crate` contains the last release source code and isn't supposed to

be updated.



This repository is structured as follows:



```text

- crate/

   |

   |-- README.md

   |-- Gir.toml

   |-- Cargo.toml

   |-- src/

   |-- sys/

```



The `crate` is a "top" directory (so "atk" or "gdk" in here for example).

Each crate contains:



 * `README.md`: explanations about the crate itself and eventually some details.

 * `Cargo.toml`: descriptor of the crate, used by `cargo` and `Rust`.

 * `Gir.toml`: configuration used by [gir] to generate most of the crates' code.

 * `src`: the source code of the crate.

 * `sys`: the 1:1 bindings of the C API.



The `gir` and `gir-files` top folders are not crates, but are git submodules

which respectively contain the [gir] tool and the [gir files] used by the generator.



When running `generator.py` the tool will automatically update these git

submodules and run the [gir] tool on the [gir files] to regenerate the code.



During development, it is useful to execute the generator with a different

version of the [gir] tool or of the [gir files], for instance to test if

the code generation is successful before submitting a pull request to update

one of the submodules. This can be done by specifying arguments to the

generator script, for instance, to run the generator on a local copy of the

gir files:



```bash

$ python3 generator.py --gir-files-directory ../gir-files/

```



See `python3 generator.py --help` for more details.



[gir]: https://github.com/gtk-rs/gir

[gir files]: https://github.com/gtk-rs/gir-files