[#690] Add missing documentation and fix clippy warnings

Author: elfenpiff

iceoryx2/src/port/client.rs

@@ -354,7 +354,7 @@ impl<
             data_segment,
             segment_states: {
                 let mut v =
-                    std::vec::Vec::<SegmentState>::with_capacity(max_number_of_segments as usize);
+                    alloc::vec::Vec::<SegmentState>::with_capacity(max_number_of_segments as usize);
                 for _ in 0..max_number_of_segments {
                     v.push(SegmentState::new(number_of_requests))
                 }
@@ -690,6 +690,41 @@ impl<
         ResponseHeader: Debug + ZeroCopySend,
     > Client<Service, [RequestPayload], RequestHeader, ResponsePayload, ResponseHeader>
 {
+    /// Loans/allocates a [`RequestMut`] from the underlying data segment of the [`Client`]
+    /// and initializes all slice elements with the default value. This can be a performance hit
+    /// and [`Client::loan_slice_uninit()`] can be used to loan a slice of
+    /// [`core::mem::MaybeUninit<Payload>`].
+    ///
+    /// On failure it returns [`LoanError`] describing the failure.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use iceoryx2::prelude::*;
+    ///
+    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+    /// # let node = NodeBuilder::new().create::<ipc::Service>()?;
+    /// #
+    /// let service = node
+    ///    .service_builder(&"My/Funk/ServiceName".try_into()?)
+    ///    .request_response::<[u64], u64>()
+    ///    .open_or_create()?;
+    ///
+    /// let client = service.client_builder()
+    ///                     .initial_max_slice_len(32)
+    ///                     .create()?;
+    ///
+    /// let slice_length = 13;
+    /// let mut request = client.loan_slice(slice_length)?;
+    /// for element in request.payload_mut() {
+    ///     element = 1234;
+    /// }
+    ///
+    /// let pending_response = request.send()?;
+    ///
+    /// # Ok(())
+    /// # }
+    /// ```
     pub fn loan_slice(
         &self,
         slice_len: usize,
@@ -710,6 +745,42 @@ impl<
         ResponseHeader: Debug + ZeroCopySend,
     > Client<Service, [RequestPayload], RequestHeader, ResponsePayload, ResponseHeader>
 {
+    /// Loans/allocates a [`RequestMutUninit`] from the underlying data segment of the [`Client`].
+    /// The user has to initialize the payload before it can be sent.
+    ///
+    /// On failure it returns [`LoanError`] describing the failure.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use iceoryx2::prelude::*;
+    ///
+    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+    /// # let node = NodeBuilder::new().create::<ipc::Service>()?;
+    /// #
+    /// let service = node
+    ///    .service_builder(&"My/Funk/ServiceName".try_into()?)
+    ///    .request_response::<[u64], u64>()
+    ///    .open_or_create()?;
+    ///
+    /// let client = service.client_builder()
+    ///                     .initial_max_slice_len(32)
+    ///                     .create()?;
+    ///
+    /// let slice_length = 13;
+    /// let mut request = client.loan_slice_uninit(slice_length)?;
+    /// for element in request.payload_mut() {
+    ///     element.write(1234);
+    /// }
+    /// // we have written the payload, initialize the request
+    /// let request = unsafe { request.assume_init() };
+    ///
+    /// let pending_response = request.send()?;
+    ///
+    /// # Ok(())
+    /// # }
+    /// ```
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub fn loan_slice_uninit(
         &self,
         slice_len: usize,
@@ -727,6 +798,7 @@ impl<
         unsafe { self.loan_slice_uninit_impl(slice_len, slice_len) }
     }
 
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     unsafe fn loan_slice_uninit_impl(
         &self,
         slice_len: usize,
@@ -817,6 +889,7 @@ impl<
     > Client<Service, [CustomPayloadMarker], RequestHeader, ResponsePayload, ResponseHeader>
 {
     #[doc(hidden)]
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub unsafe fn loan_custom_payload(
         &self,
         slice_len: usize,

iceoryx2/src/port/server.rs

@@ -283,7 +283,7 @@ impl<
         let response_sender = Sender {
             segment_states: {
                 let mut v =
-                    std::vec::Vec::<SegmentState>::with_capacity(max_number_of_segments as usize);
+                    alloc::vec::Vec::<SegmentState>::with_capacity(max_number_of_segments as usize);
                 for _ in 0..max_number_of_segments {
                     v.push(SegmentState::new(number_of_responses))
                 }
@@ -570,6 +570,7 @@ impl<
     /// # Ok(())
     /// # }
     /// ```
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub fn receive(
         &self,
     ) -> Result<
@@ -624,6 +625,7 @@ impl<
     > Server<Service, [CustomPayloadMarker], RequestHeader, ResponsePayload, ResponseHeader>
 {
     #[doc(hidden)]
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub unsafe fn receive_custom_payload(
         &self,
     ) -> Result<

iceoryx2/src/service/builder/request_response.rs

@@ -1215,6 +1215,7 @@ impl<
 
     /// If the [`Service`] exists, it will be opened otherwise a new [`Service`] will be
     /// created.
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub fn open_or_create(
         self,
     ) -> Result<
@@ -1236,6 +1237,7 @@ impl<
     /// If the [`Service`] already exists all attribute requirements must be satisfied,
     /// and service payload type must be the same, otherwise the open process will fail.
     /// If the [`Service`] does not exist the required attributes will be defined in the [`Service`].
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub fn open_or_create_with_attributes(
         mut self,
         required_attributes: &AttributeVerifier,
@@ -1254,6 +1256,7 @@ impl<
     }
 
     /// Opens an existing [`Service`].
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub fn open(
         self,
     ) -> Result<
@@ -1271,6 +1274,7 @@ impl<
 
     /// Opens an existing [`Service`] with attribute requirements. If the defined attribute
     /// requirements are not satisfied the open process will fail.
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub fn open_with_attributes(
         mut self,
         required_attributes: &AttributeVerifier,
@@ -1289,6 +1293,7 @@ impl<
     }
 
     /// Creates a new [`Service`].
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub fn create(
         self,
     ) -> Result<
@@ -1305,6 +1310,7 @@ impl<
     }
 
     /// Creates a new [`Service`] with a set of attributes.
+    #[allow(clippy::type_complexity)] // type alias would require 5 generic parameters which hardly reduces complexity
     pub fn create_with_attributes(
         mut self,
         attributes: &AttributeSpecifier,

iceoryx2/src/service/header/publish_subscribe.rs

@@ -60,7 +60,7 @@ impl Header {
     /// Returns how many elements are stored inside the sample's payload.
     ///
     /// # Details when using
-    /// [`CustomPayloadMarker`](crate::service::builder::publish_subscribe::CustomPayloadMarker)
+    /// [`CustomPayloadMarker`](crate::service::builder::CustomPayloadMarker)
     ///
     /// In this case the number of elements relates to the element defined in the
     /// [`MessageTypeDetails`](crate::service::static_config::message_type_details::MessageTypeDetails).

iceoryx2/src/service/header/request_response.rs

@@ -36,7 +36,7 @@ impl RequestHeader {
     /// Returns how many elements are stored inside the requests's payload.
     ///
     /// # Details when using
-    /// [`CustomPayloadMarker`](crate::service::builder::publish_subscribe::CustomPayloadMarker)
+    /// [`CustomPayloadMarker`](crate::service::builder::CustomPayloadMarker)
     ///
     /// In this case the number of elements relates to the element defined in the
     /// [`MessageTypeDetails`](crate::service::static_config::message_type_details::MessageTypeDetails).
@@ -67,7 +67,7 @@ impl ResponseHeader {
     /// Returns how many elements are stored inside the response's payload.
     ///
     /// # Details when using
-    /// [`CustomPayloadMarker`](crate::service::builder::publish_subscribe::CustomPayloadMarker)
+    /// [`CustomPayloadMarker`](crate::service::builder::CustomPayloadMarker)
     ///
     /// In this case the number of elements relates to the element defined in the
     /// [`MessageTypeDetails`](crate::service::static_config::message_type_details::MessageTypeDetails).

iceoryx2/src/service/port_factory/client.rs

@@ -198,21 +198,13 @@ impl<
 }
 
 impl<
-        'factory,
         Service: service::Service,
         RequestPayload: Debug + ZeroCopySend,
         RequestHeader: Debug + ZeroCopySend,
         ResponsePayload: Debug + ZeroCopySend + ?Sized,
         ResponseHeader: Debug + ZeroCopySend,
     >
-    PortFactoryClient<
-        'factory,
-        Service,
-        [RequestPayload],
-        RequestHeader,
-        ResponsePayload,
-        ResponseHeader,
-    >
+    PortFactoryClient<'_, Service, [RequestPayload], RequestHeader, ResponsePayload, ResponseHeader>
 {
     /// Sets the maximum slice length that a user can allocate with
     /// [`Client::loan_slice()`] or [`Client::loan_slice_uninit()`].

iceoryx2/src/service/port_factory/server.rs

@@ -212,21 +212,13 @@ impl<
 }
 
 impl<
-        'factory,
         Service: service::Service,
         RequestPayload: Debug + ZeroCopySend + ?Sized,
         RequestHeader: Debug + ZeroCopySend,
         ResponsePayload: Debug + ZeroCopySend,
         ResponseHeader: Debug + ZeroCopySend,
     >
-    PortFactoryServer<
-        'factory,
-        Service,
-        RequestPayload,
-        RequestHeader,
-        [ResponsePayload],
-        ResponseHeader,
-    >
+    PortFactoryServer<'_, Service, RequestPayload, RequestHeader, [ResponsePayload], ResponseHeader>
 {
     /// Sets the maximum slice length that a user can allocate with
     /// [`ActiveRequest::loan_slice()`](crate::active_request::ActiveRequest::loan_slice()) or