[eclipse-iceoryx#690] Extend code examples

Author: elfenpiff

examples/rust/request_response_dynamic_data/README.md

@@ -29,6 +29,7 @@ increasing memory size.
 
 The `initial_max_slice_len` hint and the `AllocationStrategy` set by the
 client and server will define how memory is reallocated when
+
 * [`Client::loan_slice()`], [`Client::loan_slice_uninit()`] on the client
   side or
 * [`ActiveRequest::loan_slice()`], [`ActiveRequest::loan_slice_uninit()`] on

iceoryx2/src/port/client.rs

@@ -38,7 +38,39 @@
 //! # Ok(())
 //! # }
 //! ```
-
+//!
+//! ## Slice API
+//!
+//! ```
+//! 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::<[usize], u64>()
+//!    .open_or_create()?;
+//!
+//! let client = service.client_builder()
+//!     // provides a hint for the max slice len, 128 means we want at
+//!     // list a slice of 128 `usize`
+//!     .initial_max_slice_len(128)
+//!     // The underlying sample size will be increased with a power of two strategy
+//!     // when [`Client::loan_slice()`] or [`Client::loan_slice_uninit()`] requires more
+//!     // memory than available.
+//!     .allocation_strategy(AllocationStrategy::PowerOfTwo)
+//!    .create()?;
+//!
+//! let number_of_elements = 10;
+//! let request = client.loan_slice_uninit(number_of_elements)?;
+//! let request = request.write_from_fn(|idx| idx * 2 + 1);
+//!
+//! let pending_response = request.send()?;
+//!
+//! # Ok(())
+//! # }
+//! ```
 extern crate alloc;
 
 use alloc::sync::Arc;

iceoryx2/src/port/server.rs

@@ -12,6 +12,8 @@
 
 //! # Example
 //!
+//! ## Typed API
+//!
 //! ```
 //! use iceoryx2::prelude::*;
 //!
@@ -23,10 +25,49 @@
 //!     .request_response::<u64, u64>()
 //!     .open_or_create()?;
 //!
-//! let server = service.server_builder().create()?;
+//! let server = service.server_builder()
+//!    // defines behavior when client queue is full in a non-overflowing service
+//!    .unable_to_deliver_strategy(UnableToDeliverStrategy::DiscardSample)
+//!    .create()?;
+//!
+//! while let Some(active_request) = server.receive()? {
+//!     println!("received request: {:?}", *active_request);
+//!     let response = active_request.loan_uninit()?;
+//!     let response = response.write_payload(871238);
+//!     response.send()?;
+//! }
+//! # Ok(())
+//! # }
+//! ```
+//!
+//! ## Slice API
+//!
+//! ```
+//! 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, [usize]>()
+//!     .open_or_create()?;
+//!
+//! let server = service.server_builder()
+//!     // provides a hint for the max slice len, 128 means we want at
+//!     // list a slice of 128 `usize`
+//!     .initial_max_slice_len(128)
+//!     // The underlying sample size will be increased with a power of two strategy
+//!     // when [`ActiveRequest::loan_slice()`] or [`ActiveRequest::loan_slice_uninit()`]
+//!     // requires more memory than available.
+//!     .create()?;
 //!
+//! let number_of_elements = 10;
 //! while let Some(active_request) = server.receive()? {
 //!     println!("received request: {:?}", *active_request);
+//!     let response = active_request.loan_slice_uninit(number_of_elements)?;
+//!     let response = response.write_from_fn(|idx| idx * 3 + 4);
+//!     response.send()?;
 //! }
 //! # Ok(())
 //! # }