Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
OlivierHecart committed Dec 6, 2024
1 parent f850eaa commit 1799a95
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 4 deletions.
4 changes: 3 additions & 1 deletion zenoh-ext/src/advanced_cache.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ kedefine!(
pub(crate) ke_liveliness: "@adv/${zid:*}/${eid:*}/${meta:**}/@/${remaining:**}",
);

/// Configure replies QoS.
#[derive(Clone, Debug)]
pub struct QoS {
priority: Priority,
Expand Down Expand Up @@ -104,7 +105,7 @@ impl CacheConfig {
}
}

/// The builder of AdvancedCache, allowing to configure it.
/// The builder of an [`AdvancedCache`], allowing to configure it.
pub struct AdvancedCacheBuilder<'a, 'b, 'c> {
session: &'a Session,
pub_key_expr: ZResult<KeyExpr<'b>>,
Expand Down Expand Up @@ -187,6 +188,7 @@ fn sample_in_range(sample: &Sample, start: Option<u32>, end: Option<u32>) -> boo
}
}

/// [`AdvancedCache`].
pub struct AdvancedCache {
cache: Arc<RwLock<VecDeque<Sample>>>,
max_samples: usize,
Expand Down
3 changes: 2 additions & 1 deletion zenoh-ext/src/advanced_publisher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ use zenoh::{
use crate::advanced_cache::{AdvancedCache, AdvancedCacheBuilder, CacheConfig, KE_UHLC};

#[derive(PartialEq)]
pub enum Sequencing {
pub(crate) enum Sequencing {
None,
Timestamp,
SequenceNumber,
Expand Down Expand Up @@ -126,6 +126,7 @@ impl IntoFuture for AdvancedPublisherBuilder<'_, '_, '_> {
}
}

/// [`AdvancedPublisher`].
pub struct AdvancedPublisher<'a> {
publisher: Publisher<'a>,
seqnum: Option<AtomicU32>,
Expand Down
3 changes: 2 additions & 1 deletion zenoh-ext/src/advanced_subscriber.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ impl RecoveryConfig {
}
}

/// The builder of AdvancedSubscriber, allowing to configure it.
/// The builder of an [`AdvancedSubscriber`], allowing to configure it.
#[zenoh_macros::unstable]
pub struct AdvancedSubscriberBuilder<'a, 'b, 'c, Handler, const BACKGROUND: bool = false> {
pub(crate) session: &'a Session,
Expand Down Expand Up @@ -373,6 +373,7 @@ struct SourceState<T> {
pending_samples: BTreeMap<T, Sample>,
}

/// [`AdvancedSubscriber`].
#[zenoh_macros::unstable]
pub struct AdvancedSubscriber<Receiver> {
statesref: Arc<Mutex<State>>,
Expand Down
2 changes: 1 addition & 1 deletion zenoh-ext/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ pub use crate::serialization::{
#[allow(deprecated)]
pub use crate::{
advanced_cache::{CacheConfig, QoS},
advanced_publisher::{AdvancedPublisher, AdvancedPublisherBuilder, Sequencing},
advanced_publisher::{AdvancedPublisher, AdvancedPublisherBuilder},
advanced_subscriber::{
AdvancedSubscriber, AdvancedSubscriberBuilder, HistoryConfig, RecoveryConfig,
},
Expand Down
1 change: 1 addition & 0 deletions zenoh-ext/src/publication_cache.rs
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ impl IntoFuture for PublicationCacheBuilder<'_, '_, '_, true> {
}
}

/// [`PublicationCache`].
#[zenoh_macros::unstable]
#[deprecated = "Use `AdvancedPublisher` and `AdvancedSubscriber` instead."]
pub struct PublicationCache {
Expand Down
1 change: 1 addition & 0 deletions zenoh-ext/src/querying_subscriber.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1072,6 +1072,7 @@ where
}))
}

/// [`ExtractSample`].
#[zenoh_macros::unstable]
#[deprecated = "Use `AdvancedPublisher` and `AdvancedSubscriber` instead."]
#[allow(deprecated)]
Expand Down

0 comments on commit 1799a95

Please sign in to comment.