From dd7b22e2a7fefa8dae0e3afc401f67c5a4a60398 Mon Sep 17 00:00:00 2001 From: Be Date: Mon, 26 May 2025 14:36:36 -0500 Subject: [PATCH] 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: --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8b27ca2ab..67411183b 100644 --- a/README.md +++ b/README.md @@ -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