pubsub doc/samples aligned (#12)

Author: rex-schilasky

docs/src/api/message_types.md

@@ -15,8 +15,8 @@ Used for binary `Vec<u8>` payloads.
 Supports publishing/receiving of Protobuf types that implement `Message` and `Default`.
 
 ```rust
-use rustecal::types::ProtobufMessage;
+use rustecal_types_protobuf::ProtobufMessage;
 use my_proto::MyProto;
 
-let pub = Publisher::<ProtobufMessage<MyProto>>::builder("proto_topic").create()?;
+let publisher = Publisher::<ProtobufMessage<MyProto>>::builder("proto_topic").create()?;
 ```

docs/src/api/publisher.md

@@ -6,8 +6,8 @@ The `Publisher<T>` allows you to publish messages of type `T` on a topic.
 
 ```rust
 use rustecal::pubsub::Publisher;
-use rustecal::types::StringMessage;
+use rustecal_types::StringMessage;
 
-let pub = Publisher::<StringMessage>::builder("my_topic").create()?;
-pub.send("Rust rocks!")?;
+let publisher = Publisher::<StringMessage>::builder("my_topic").create()?;
+publisher.send("Rust rocks!")?;
 ```

docs/src/api/service_client.md

@@ -48,4 +48,4 @@ match response {
 
 ## Runtime Compatibility
 
-This API matches the usage and behavior of `mirror_client.cpp` in the eCAL C++ samples.
+This API is fully compatible with the C++ `mirror_client.cpp` and C `mirror_client_c.c` examples.

docs/src/api/service_server.md

@@ -47,4 +47,4 @@ Response : desserts
 
 ## Runtime Compatibility
 
-This API is fully compatible with the C++ `mirror_server.cpp` and C `mirror_server.c` examples.
+This API is fully compatible with the C++ `mirror_server.cpp` and C `mirror_server_c.c` examples.

docs/src/api/subscriber.md

@@ -6,10 +6,10 @@ The `Subscriber<T>` enables you to subscribe to messages of type `T` on a topic.
 
 ```rust
 use rustecal::pubsub::Subscriber;
-use rustecal::types::StringMessage;
+use rustecal_types::StringMessage;
 
-let sub = Subscriber::<StringMessage>::builder("my_topic").create()?;
-sub.set_callback(|msg| {
+let subscriber = Subscriber::<StringMessage>::builder("my_topic").create()?;
+subscriber.set_callback(|msg| {
     println!("Received: {}", msg.data());
 });
 ```

docs/src/examples/binary.md

@@ -3,6 +3,7 @@
 ## Publisher
 
 ```rust
+use std::sync::Arc;
 use rustecal::{Ecal, EcalComponents, TypedPublisher};
 use rustecal_types_bytes::BytesMessage;
 
@@ -14,9 +15,9 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     let mut counter = 0u8;
     while Ecal::ok() {
         let buf = vec![counter; 1024];
+        counter = counter.wrapping_add(1);
         publisher.send(&BytesMessage(Arc::from(buf)));
 
-        counter = counter.wrapping_add(1);
         std::thread::sleep(std::time::Duration::from_millis(500));
     }
 
@@ -36,7 +37,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     let mut subscriber = TypedSubscriber::<BytesMessage>::new("blob")?;
     subscriber.set_callback(|msg| {
-        println!("Received blob of {} bytes", msg.msg.0.len());
+        println!("Received blob of {} bytes", msg.payload.data.len());
     });
 
     while Ecal::ok() {

docs/src/examples/protobuf.md

@@ -48,7 +48,9 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     Ecal::initialize(Some("protobuf subscriber"), EcalComponents::DEFAULT)?;
 
     let mut subscriber = TypedSubscriber::<ProtobufMessage<Person>>::new("person")?;
-    subscriber.set_callback(|msg| println!("Received person: {}", msg.msg.0.name));
+    subscriber.set_callback(|msg| {
+        println!("Received person: {}", msg.payload.data.name)
+    });
 
     while Ecal::ok() {
         std::thread::sleep(std::time::Duration::from_millis(500));

docs/src/examples/service_client.md

@@ -9,7 +9,6 @@ use rustecal::{Ecal, EcalComponents, ServiceClient, ServiceRequest};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     Ecal::initialize(Some("mirror_client"), EcalComponents::DEFAULT)?;
-    println!("mirror_client initialized. Sending requests…");
 
     let client = ServiceClient::new("mirror_service")?;
 

docs/src/examples/string.md

@@ -33,7 +33,9 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     Ecal::initialize(Some("string subscriber"), EcalComponents::DEFAULT)?;
 
     let mut subscriber = TypedSubscriber::<StringMessage>::new("hello")?;
-    subscriber.set_callback(|msg| println!("Received: {}", msg.msg.0));
+    subscriber.set_callback(|msg| {
+        println!("Received: {}", msg.payload.data)
+    });
 
     while Ecal::ok() {
         std::thread::sleep(std::time::Duration::from_millis(500));

docs/src/types/message_types.md

@@ -2,6 +2,6 @@
 
 - `BytesMessage` – Arbitrary binary data
 - `StringMessage` – UTF-8 encoded strings
-- `ProtobufMessage<T>` – Protobuf messages (via `prost`)
+- `ProtobufMessage<T>` – Protobuf messages
 
 Each type is provided via a dedicated crate to avoid pulling unnecessary dependencies.