Add Rust client library fro GstD with examples by lmerayo1 · Pull Request #338 · RidgeRun/gstd-1.x

lmerayo1 · 2026-03-27T21:20:00Z

No description provided.

rrcarlosrodriguez · 2026-03-27T21:44:43Z

@@ -0,0 +1,211 @@
+/*
+ * This file is part of GStreamer Daemon
+ * Copyright 2015-2022 Ridgerun, LLC (http://www.ridgerun.com)


Change to:

Copyright 2015-2026 RidgeRun, LLC (http://www.ridgerun.com)

Apply this to all the files in the PR

rrcarlosrodriguez · 2026-03-27T21:46:01Z

    install: false)
 endforeach
+
+subdir('rust')


Add a README inside examples/libgstc/rust/ explaining what each example does and how to run them

michaelgruner · 2026-03-30T23:29:55Z

+    println!("Pipeline set to playing!");
+
+    println!("Press enter to stop the pipeline...");
+    let (tx, rx) = mpsc::channel::<()>();


I honestly think mpsc is overkill here. I'd recommend a simple Atomic boolean for the exit flag.

michaelgruner · 2026-03-30T23:33:14Z

+
+    let abs_path = PathBuf::from(&video)
+        .canonicalize()
+        .unwrap_or_else(|_| PathBuf::from(video));


Prefer borrowing here PathBuf::from(&video)

michaelgruner · 2026-03-30T23:33:50Z

+    println!("Pipeline set to playing!");
+
+    println!("Press enter to stop the pipeline...");
+    let (tx, rx) = mpsc::channel::<()>();


Same comment here

michaelgruner · 2026-03-30T23:38:42Z

+    if bus_message.status == Status::OK {
+        println!("received!");
+    } else if bus_message.status == Status::BUS_TIMEOUT {
+        println!("timeout!");
+        eprintln!("EOS not received, file may be unreadable");
+    } else {
+        println!("error!");
+        eprintln!(
+            "An error occurred waiting for EOS: {}",
+            bus_message.status.0
+        );
+    }


Prefer matching here.

michaelgruner · 2026-03-30T23:41:38Z

@@ -0,0 +1,45 @@
+/*


I don't like this example name. Maybe wait_on_bus or something like that.

michaelgruner · 2026-03-31T00:04:14Z

+use std::fmt;
+
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+pub struct Status(pub i32);


Why a struct and not an enum? An enum is the more intuitive option here.

michaelgruner · 2026-03-31T00:07:22Z

+}
+
+pub(crate) struct Transport {
+    settings: ConnectionSettings,


I suggest we make this public so the client can read our settings.

michaelgruner · 2026-03-31T00:10:16Z

+            if self.stream.is_none() {
+                let stream = self.open_socket()?;
+                self.stream = Some(stream);
+            }


To me, this overprotection is an antipattern. If this happens, this is an error and we don't want to silence it. Why would the stream be closed? If we opened with keep_connection_open the stream should be open, if not, something went wrong and we should react accordingly.

michaelgruner · 2026-03-31T00:11:16Z

+        if timeout_ms < 0 {
+            stream
+                .set_read_timeout(None)
+                .map_err(|_| Status::SOCKET_ERROR)?;
+        } else {
+            stream
+                .set_read_timeout(Some(Duration::from_millis(timeout_ms as u64)))
+                .map_err(|_| Status::SOCKET_ERROR)?;
+        }


Please refactor this to set the timeout instead of duplicating all the code.

michaelgruner · 2026-03-31T00:15:13Z

+rust_enabled = add_languages('rust', required : false)
+
+if rust_enabled
+  subdir('gstc')
+else
+  message('Rust compiler not found; skipping libgstc Rust API')
+endif


Please follow the same pattern we use with python.

The ConnectionSettings are accesible through some helper methods in client.rs.

michaelgruner · 2026-04-28T17:42:03Z

+
+        println!("EOS message received!");
+
+        client.pipeline_seek("pipe", 1.0, 3, 1, 1, 0, 1, -1)?;


Can we make local constants for these magic numbers? to give us an idea of what they are.

michaelgruner · 2026-04-28T17:44:01Z

@@ -0,0 +1,25 @@
+if is_variable('lib_gstc_rust_dep')
+  rustc = find_program('rustc')


Meson supports rust by default. Don't build manually. Add rust as the list of project languages and it will do it on its own.

michaelgruner · 2026-04-28T17:44:16Z

+
+  foreach ex : rust_examples
+    executable(ex[0], ex[1],
+      rust_args : ['--edition=2021'],


Add this do the default options as rust_std=2021

michaelgruner · 2026-04-28T17:50:50Z

+
+use crate::Status;
+
+pub(crate) fn json_get_int(json: &str, name: &str) -> Result<i32, Status> {


I vote for using meson 1.11, pip already has meson 1.11.1. But creating a JSON parser from scratch is something i'm not interested in maintaining.

michaelgruner · 2026-04-28T19:16:48Z

+    println!("EOS sent!");
+
+    print!("Waiting for EOS... ");
+    let bus_message = client.pipeline_bus_wait("pipe", "eos", 10_000_000_000)?;


I suggest we treat Status::BusTimeout as an error as well. This is counterintuitive., IMO.

match client.pipeline_bus_wait("pipe", "eos", 10_000_000_000) { Ok(_bus_message) => { println!("received!"); } Err(Status::BusTimeout) => { println!("timeout!"); eprintln!("EOS not received, file may be unreadable"); } Err(status) => { println!("error!"); eprintln!( "An error occurred waiting for EOS: {}", status.code() ); } }

michaelgruner · 2026-04-28T19:21:08Z

+        let status = match json_is_null_field(&raw, "response") {
+            Ok(is_null) if is_null => Status::BusTimeout,
+            Ok(_) => Status::Ok,
+            Err(err) => err,
+        };
+
+        Ok(BusMessage {
+            status,
+            raw_response: raw,
+        })


Let's treat BusTimeout as an Err()

michaelgruner · 2026-04-28T19:22:29Z

+        self.cmd_update(
+            &format!("/pipelines/{}/bus/types", pipeline_name),
+            &message_name,
+        )?;
+        self.cmd_update(
+            &format!("/pipelines/{}/bus/timeout", pipeline_name),
+            &format!("{}", timeout_ns),
+        )?;


This values are already written by pipeline_bus_wait(), which you are already calling. Why write them twice?

michaelgruner · 2026-04-28T19:27:38Z

+ * Boston, MA 02110-1301, USA.
+ */
+
+use gstc_rust::{Client, Status};


drop the rust in gstc_rust. Just gstc.

michaelgruner · 2026-04-28T19:32:02Z

+            ),
+            self.default_wait_time_ms()?,
+        )?;
+        Ok(())


Unnecessary.

michaelgruner · 2026-04-28T19:33:43Z

+    fn cmd_send(&self, request: &str) -> Result<(), Status> {
+        let response = self.send_request(request, self.default_wait_time_ms()?)?;
+        let code = json_get_int(&response, "code")?;
+        let status = Status::from_code(code);
+
+        if status.is_ok() {
+            Ok(())
+        } else {
+            Err(status)
+        }
+    }


Rewrite this in terms of cmd_send_get_response

Rewrite cmd_send in terms of cmd_send_get_response and fix unnecessary return function.

Remove meson Rust logic because external depencies in Rust are needed and meson support is not working as intended.

michaelgruner · 2026-05-27T18:12:02Z

+    let client = Client::new("127.0.0.1", 5000, -1, true)?;
+    let output = env::current_dir().map(|dir| dir.join("mp4_recording.mp4"))?;
+    let output = output.to_string_lossy();
+    let output = output.replace('\\', "\\\\").replace('"', "\\\"");


We shouldn't be manually escaping. 1) Do we really need to escape? 2) If so, let's use something specific for escaping shell strings, like shell_escape::unix::escape, but not manually.

michaelgruner · 2026-05-27T18:15:38Z

+fn main() -> Result<(), Status> {
+    let client = Client::new("127.0.0.1", 5000, 5000, false)?;
+
+    client.pipeline_create("pipe", "videotestsrc ! fakesink")?;


Please either use videotestsrc is-live=true or fakesink sync=true otherwise we are going to eat up the processor.

lmerayo1 requested a review from michaelgruner March 27, 2026 21:20

lmerayo1 self-assigned this Mar 27, 2026

Add Cargo.toml for Rust Client

ed182a1

rrcarlosrodriguez requested changes Mar 27, 2026

View reviewed changes

lmerayo1 added 2 commits March 27, 2026 15:52

Add Rust client source code

5e41bd0

Add examples for Rust client

1caf51e

lmerayo1 force-pushed the feature/add-rust-api branch from e9fd940 to 1caf51e Compare March 27, 2026 22:02

michaelgruner requested changes Mar 31, 2026

View reviewed changes

lmerayo1 added 12 commits March 31, 2026 08:47

Update license header

e6ae8dd

use Atomic bool as stop flag for thread

aa3275c

Use pattern matching instead of if-else

0c57b97

Rename examples and add missing meson.build files

c7ad404

Keep ConnectionSettings in transport struct

09fb394

The ConnectionSettings are accesible through some helper methods in client.rs.

Fix typo

f5ec760

Replace Status with an enum

2fac0a5

Remove unnecessary socket reconnection attempt

0ae81b7

Refactor timeout calculation

9c78186

Reformat Rust library building in Meson

9586059

Use CamelCase in Rust Status enum values

157f066

Add README with how to run Rust examples

8c26a02

lmerayo1 requested a review from michaelgruner April 13, 2026 21:12

michaelgruner requested changes Apr 28, 2026

View reviewed changes

lmerayo1 added 8 commits May 11, 2026 11:14

Add constants for seek function

a549459

Reformat Status::BusTimeout as error

2997bd5

Fix return of cmd_update

76a1631

Treat Status::BusTimeout as error

6f46532

Remove repeated function calls

c4b4a7e

Rewrite cmd_send and fix return errors

dbb418b

Rewrite cmd_send in terms of cmd_send_get_response and fix unnecessary return function.

Remove meson build logic for Rust API

8d7f461

Remove meson Rust logic because external depencies in Rust are needed and meson support is not working as intended.

Replace custom json handling logic for serde_json dep

4c58a72

lmerayo1 added 5 commits May 18, 2026 18:08

Replace gstc_rust with gstc for the crate name

0be7a58

Fix recording artifact save location

0667e3a

Add root Cargo files

42c2098

Update documentation

a0cb09c

Apply format to rust files

5ef83e2

michaelgruner requested changes May 27, 2026

View reviewed changes

lmerayo1 added 2 commits May 27, 2026 14:02

Add is-live=true to avoid consuming CPU

cdf6c7f

Remove character escaping

206f7ef

michaelgruner approved these changes May 27, 2026

View reviewed changes

lmerayo1 merged commit 1d65181 into develop May 28, 2026
4 of 6 checks passed


		println!("EOS message received!");

		client.pipeline_seek("pipe", 1.0, 3, 1, 1, 0, 1, -1)?;

		@@ -0,0 +1,25 @@
		if is_variable('lib_gstc_rust_dep')
		rustc = find_program('rustc')


		use crate::Status;

		pub(crate) fn json_get_int(json: &str, name: &str) -> Result<i32, Status> {

Conversation

lmerayo1 commented Mar 27, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants