[eclipse-iceoryx#532] Fix doc issues

iceoryx2-cal/src/zero_copy_connection/common.rs

@@ -555,11 +555,11 @@ pub mod details {
 
             let segment_id = ptr.segment_id().value() as usize;
             let segment_details = &storage.segment_details[segment_id];
-            debug_assert!(ptr.offset() % segment_details.sample_size.load(Ordering::Relaxed) == 0);
             segment_details
                 .sample_size
                 .store(sample_size, Ordering::Relaxed);
-            let index = ptr.offset() / segment_details.sample_size.load(Ordering::Relaxed);
+            debug_assert!(ptr.offset() % sample_size == 0);
+            let index = ptr.offset() / sample_size;
 
             debug_assert!(segment_id < storage.number_of_segments as usize);
 
@@ -569,13 +569,14 @@ pub mod details {
             match unsafe { storage.submission_channel.push(ptr.as_value()) } {
                 Some(v) => {
                     let pointer_offset = PointerOffset::from_value(v);
+                    let segment_id = pointer_offset.segment_id().value() as usize;
+
+                    let segment_details = &storage.segment_details[segment_id];
                     debug_assert!(
                         pointer_offset.offset()
                             % segment_details.sample_size.load(Ordering::Relaxed)
                             == 0
                     );
-                    let segment_id = pointer_offset.segment_id().value() as usize;
-                    let segment_details = &storage.segment_details[segment_id];
                     let index = pointer_offset.offset()
                         / segment_details.sample_size.load(Ordering::Relaxed);
 

iceoryx2-cal/tests/zero_copy_connection_trait_tests.rs

@@ -531,7 +531,7 @@ mod zero_copy_connection {
 
     #[test]
     fn blocking_send_blocks<Sut: ZeroCopyConnection>() {
-        let watchdog = Watchdog::new();
+        let _watchdog = Watchdog::new();
         let name = generate_name();
         let config = Mutex::new(generate_isolated_config::<Sut>());
 

iceoryx2/src/port/publisher.rs

@@ -69,7 +69,7 @@
 //! let publisher = service
 //!     .publisher_builder()
 //!     // defines the maximum length of a slice
-//!     .max_slice_len(128)
+//!     .initial_max_slice_len(128)
 //!     // defines how many samples can be loaned in parallel
 //!     .max_loaned_samples(5)
 //!     // defines behavior when subscriber queue is full in an non-overflowing service
@@ -176,7 +176,7 @@ pub enum PublisherLoanError {
     ExceedsMaxLoanedSamples,
     /// The provided slice size exceeds the configured max slice size of the [`Publisher`].
     /// To send a [`SampleMut`] with this size a new [`Publisher`] has to be created with
-    /// a [`crate::service::port_factory::publisher::PortFactoryPublisher::max_slice_len()`]
+    /// a [`crate::service::port_factory::publisher::PortFactoryPublisher::initial_max_slice_len()`]
     /// greater or equal to the required len.
     ExceedsMaxLoanSize,
     /// Errors that indicate either an implementation issue or a wrongly configured system.
@@ -971,7 +971,7 @@ impl<Service: service::Service, Payload: Default + Debug, UserHeader: Debug>
     /// #     .open_or_create()?;
     /// #
     /// # let publisher = service.publisher_builder()
-    ///                          .max_slice_len(120)
+    ///                          .initial_max_slice_len(120)
     ///                          .create()?;
     ///
     /// let slice_length = 5;
@@ -1012,7 +1012,7 @@ impl<Service: service::Service, Payload: Debug, UserHeader: Debug>
     /// #     .open_or_create()?;
     /// #
     /// # let publisher = service.publisher_builder()
-    ///                          .max_slice_len(120)
+    ///                          .initial_max_slice_len(120)
     ///                          .create()?;
     ///
     /// let slice_length = 5;

iceoryx2/src/sample_mut.rs

@@ -48,7 +48,7 @@
 //! #     .publish_subscribe::<[usize]>()
 //! #     .create()?;
 //! #
-//! # let publisher = service.publisher_builder().max_slice_len(16).create()?;
+//! # let publisher = service.publisher_builder().initial_max_slice_len(16).create()?;
 //!
 //! let slice_length = 12;
 //! // initializes every element of the slice with `Default::default()`

iceoryx2/src/sample_mut_uninit.rs

@@ -49,7 +49,7 @@
 //! #     .publish_subscribe::<[usize]>()
 //! #     .create()?;
 //! #
-//! # let publisher = service.publisher_builder().max_slice_len(16).create()?;
+//! # let publisher = service.publisher_builder().initial_max_slice_len(16).create()?;
 //!
 //! let slice_length = 12;
 //! let sample = publisher.loan_slice_uninit(slice_length)?;
@@ -76,7 +76,7 @@
 //! #     .publish_subscribe::<[usize]>()
 //! #     .create()?;
 //! #
-//! # let publisher = service.publisher_builder().max_slice_len(16).create()?;
+//! # let publisher = service.publisher_builder().initial_max_slice_len(16).create()?;
 //!
 //! let slice_length = 4;
 //! let sample = publisher.loan_slice_uninit(slice_length)?;
@@ -378,7 +378,7 @@ impl<Service: crate::service::Service, Payload: Debug, UserHeader>
     /// #     .publish_subscribe::<[usize]>()
     /// #     .open_or_create()?;
     /// #
-    /// # let publisher = service.publisher_builder().max_slice_len(32).create()?;
+    /// # let publisher = service.publisher_builder().initial_max_slice_len(32).create()?;
     ///
     /// let slice_length = 10;
     /// let mut sample = publisher.loan_slice_uninit(slice_length)?;
@@ -412,7 +412,7 @@ impl<Service: crate::service::Service, Payload: Debug, UserHeader>
     /// #     .publish_subscribe::<[usize]>()
     /// #     .open_or_create()?;
     /// #
-    /// # let publisher = service.publisher_builder().max_slice_len(16).create()?;
+    /// # let publisher = service.publisher_builder().initial_max_slice_len(16).create()?;
     ///
     /// let slice_length = 12;
     /// let sample = publisher.loan_slice_uninit(slice_length)?;
@@ -452,7 +452,7 @@ impl<Service: crate::service::Service, Payload: Debug + Copy, UserHeader>
     /// #     .publish_subscribe::<[usize]>()
     /// #     .open_or_create()?;
     /// #
-    /// # let publisher = service.publisher_builder().max_slice_len(16).create()?;
+    /// # let publisher = service.publisher_builder().initial_max_slice_len(16).create()?;
     ///
     /// let slice_length = 3;
     /// let sample = publisher.loan_slice_uninit(slice_length)?;

iceoryx2/src/service/port_factory/publisher.rs

@@ -45,7 +45,7 @@
 //!
 //! let publisher = pubsub.publisher_builder()
 //!                     // allows to call Publisher::loan_slice() with up to 128 elements
-//!                     .max_slice_len(128)
+//!                     .initial_max_slice_len(128)
 //!                     .create()?;
 //!
 //! let sample = publisher.loan_slice(50)?;