rustdoc

zenoh-protocol/src/proto/msg.rs

@@ -197,6 +197,18 @@ pub mod zmsg {
     pub fn has_flag(byte: u8, flag: u8) -> bool { byte & flag != 0 }
 }
 
+/// Some informations about the associated data.
+/// 
+/// # Examples
+/// ```
+/// # use zenoh_protocol::io::RBuf;
+/// # use zenoh_protocol::proto::DataInfo;
+/// # struct FakeSample { data_info: Option<RBuf> }
+/// # let sample = FakeSample { data_info: None };
+/// if let Some(mut info) = sample.data_info {
+///     let info: DataInfo = info.read_datainfo().unwrap();
+/// }
+/// ```
 #[derive(Debug, Clone)]
 pub struct DataInfo {
     pub source_id: Option<PeerId>,

zenoh-router/src/runtime/mod.rs

@@ -97,6 +97,15 @@ impl Runtime {
     }
 }
 
+/// Struct to pass to [open](../../zenoh/net/fn.open.html) to configure the zenoh-net [Session](../../zenoh/net/struct.Session.html).
+/// 
+/// # Examples
+/// ```
+/// # use zenoh_router::runtime::Config;
+/// let config = Config::peer()
+///     .add_listener("tcp/0.0.0.0:7447")
+///     .add_peer("tcp/10.10.10.10:7447");
+/// ```
 #[derive(Debug, Clone, PartialEq)]
 pub struct Config {
     pub whatami: WhatAmI,