API Documentation

Welcome to the rustecal API documentation. This section provides an overview of the main types and traits used to interact with the eCAL communication system through safe and idiomatic Rust APIs.

Modules Overview

• Ecal — Lifecycle manager for eCAL initialization and finalization.
• Publisher<T> — Generic typed publisher used to send messages on a topic.
• Subscriber<T> — Generic typed subscriber used to receive messages.
• MessageType — Trait for enabling custom serialization of types.
• Message Wrappers:
  • StringMessage
  • BytesMessage
  • ProtobufMessage<T>

Each module has its own documentation page with examples.

Usage Highlights

#![allow(unused)]
fn main() {
let _ecal = Ecal::initialize("my_app")?;
let pub = Publisher::<StringMessage>::builder("my_topic").create()?;
pub.send("Hello from Rust!")?;
}

Explore the individual components in detail:

• Ecal Lifecycle
• Typed Publisher
• Typed Subscriber
• Supported Message Types