explain how to find Rust bindings from C names

It can be difficult to find the Rust bindings for particular C functions
with broad search terms like "device", but copying and pasting exact C
function names makes it much easier to find the Rust bindings.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer-rs/-/merge_requests/1735>
This commit is contained in:
Be 2025-05-26 14:36:36 -05:00
parent dbe6282cc6
commit 2c6da0be89

View file

@ -168,7 +168,9 @@ Manual](https://gstreamer.freedesktop.org/documentation/application-development/
While being C-centric, it explains all the fundamental concepts of GStreamer
and the code examples should be relatively easily translatable to Rust. The
API is basically the same, function/struct names are the same and everything
is only more convenient (hopefully) and safer.
is only more convenient (hopefully) and safer. The Rust APIs are annotated with
`#[doc(alias = "c_function_name")]`, so you can search for a C function name
in this documentation and find the corresponding Rust binding.
In addition there are
[tutorials](https://gstreamer.freedesktop.org/documentation/tutorials/) on the