Merge pull request #203 from elfenpiff/iox2-195-add-sliced-api

[#195] add sliced api

Author: elfenpiff

README.md

@@ -89,7 +89,8 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     let service = zero_copy::Service::new(&service_name)
         .publish_subscribe()
-        .open_or_create::<usize>()?;
+        .typed::<usize>()
+        .open_or_create()?;
 
     let publisher = service.publisher().create()?;
 
@@ -116,7 +117,8 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     let service = zero_copy::Service::new(&service_name)
         .publish_subscribe()
-        .open_or_create::<usize>()?;
+        .typed::<usize>()
+        .open_or_create()?;
 
     let subscriber = service.subscriber().create()?;
 

benchmarks/publish-subscribe/src/main.rs

@@ -29,7 +29,8 @@ fn perform_benchmark<T: Service>(iterations: u64) {
         .history_size(0)
         .subscriber_max_buffer_size(1)
         .enable_safe_overflow(true)
-        .create::<u64>()
+        .typed::<u64>()
+        .create()
         .unwrap();
 
     let service_b2a = T::new(&service_name_b2a)
@@ -39,7 +40,8 @@ fn perform_benchmark<T: Service>(iterations: u64) {
         .history_size(0)
         .subscriber_max_buffer_size(1)
         .enable_safe_overflow(true)
-        .create::<u64>()
+        .typed::<u64>()
+        .create()
         .unwrap();
 
     let barrier_handle = BarrierHandle::new();

doc/release-notes/iceoryx2-unreleased.md

@@ -20,7 +20,7 @@
 
  <!-- NOTE: Add new entries sorted by issue number to minimize the possibility of conflicts when merging. -->
 
- * Example text [#1](https://github.com/eclipse-iceoryx/iceoryx2/issues/1)
+ * `open`, `open_or_create` and `create` are untyped in pubsub-builder [#195](https://github.com/eclipse-iceoryx/iceoryx2/issues/195)
 
 ### Workflow
 
@@ -36,12 +36,19 @@
 
 ### API Breaking Changes
 
-1. Example
+1. `open`, `open_or_create` and `create` are untyped for publish-subscribe services
 
     ```rust
     // old
-    let fuu = hello().is_it_me_you_re_looking_for()
+    let service = zero_copy::Service::new(&service_name)
+        .publish_subscribe()
+        .create::<u64>() // or open::<u64>(), or open_or_create::<u64>()
+        .unwrap();
 
     // new
-    let fuu = hypnotoad().all_glory_to_the_hypnotoad()
+    let service = zero_copy::Service::new(&service_name)
+        .publish_subscribe()
+        .typed::<u64>()
+        .create() // or open(), or open_or_create()
+        .unwrap();
     ```

examples/examples/complex_data_types/complex_data_types.rs

@@ -43,7 +43,8 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         .publish_subscribe()
         .max_publishers(16)
         .max_subscribers(16)
-        .open_or_create::<ComplexDataType>()?;
+        .typed::<ComplexDataType>()
+        .open_or_create()?;
 
     let publisher = service.publisher().create()?;
     let subscriber = service.subscriber().create()?;

examples/examples/publish_subscribe/publisher.rs

@@ -21,7 +21,8 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     let service = zero_copy::Service::new(&service_name)
         .publish_subscribe()
-        .open_or_create::<TransmissionData>()?;
+        .typed::<TransmissionData>()
+        .open_or_create()?;
 
     let publisher = service.publisher().create()?;
 

examples/examples/publish_subscribe/subscriber.rs

@@ -21,7 +21,8 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     let service = zero_copy::Service::new(&service_name)
         .publish_subscribe()
-        .open_or_create::<TransmissionData>()?;
+        .typed::<TransmissionData>()
+        .open_or_create()?;
 
     let subscriber = service.subscriber().create()?;
 

iceoryx2/src/config.rs

@@ -27,7 +27,8 @@
 //!
 //! let service = zero_copy::Service::new(&service_name)
 //!     .publish_subscribe_with_custom_config(&custom_config)
-//!     .open_or_create::<u64>()?;
+//!     .typed::<u64>()
+//!     .open_or_create()?;
 //!
 //! # Ok(())
 //! # }

iceoryx2/src/lib.rs

@@ -68,7 +68,8 @@
 //! // create our port factory by creating or opening the service
 //! let service = zero_copy::Service::new(&service_name)
 //!     .publish_subscribe()
-//!     .open_or_create::<u64>()?;
+//!     .typed::<u64>()
+//!     .open_or_create()?;
 //!
 //! let subscriber = service.subscriber().create()?;
 //!
@@ -94,7 +95,8 @@
 //! // create our port factory by creating or opening the service
 //! let service = zero_copy::Service::new(&service_name)
 //!     .publish_subscribe()
-//!     .open_or_create::<u64>()?;
+//!     .typed::<u64>()
+//!     .open_or_create()?;
 //!
 //! let publisher = service.publisher().create()?;
 //!
@@ -198,7 +200,8 @@
 //!     .max_subscribers(5)
 //!     // the maximum amount of publishers of this service
 //!     .max_publishers(2)
-//!     .create::<u64>()?;
+//!     .typed::<u64>()
+//!     .create()?;
 //!
 //! # Ok(())
 //! # }
@@ -245,7 +248,8 @@
 //! let service = zero_copy::Service::new(&service_name)
 //!     .publish_subscribe()
 //!     .enable_safe_overflow(false)
-//!     .open_or_create::<u64>()?;
+//!     .typed::<u64>()
+//!     .open_or_create()?;
 //!
 //! let publisher = service.publisher()
 //!     // the maximum amount of samples this publisher can loan in parallel

iceoryx2/src/port/publisher.rs

@@ -19,7 +19,8 @@
 //! let service_name = ServiceName::new("My/Funk/ServiceName")?;
 //! let service = zero_copy::Service::new(&service_name)
 //!     .publish_subscribe()
-//!     .open_or_create::<u64>()?;
+//!     .typed::<u64>()
+//!     .open_or_create()?;
 //!
 //! let publisher = service
 //!     .publisher()
@@ -591,7 +592,8 @@ impl<Service: service::Service, MessageType: Debug> Publisher<Service, MessageTy
     /// #
     /// # let service = zero_copy::Service::new(&service_name)
     /// #     .publish_subscribe()
-    /// #     .open_or_create::<u64>()?;
+    /// #     .typed::<u64>()
+    /// #     .open_or_create()?;
     /// #
     /// # let publisher = service.publisher().create()?;
     ///
@@ -625,7 +627,8 @@ impl<Service: service::Service, MessageType: Debug> Publisher<Service, MessageTy
     /// #
     /// # let service = zero_copy::Service::new(&service_name)
     /// #     .publish_subscribe()
-    /// #     .open_or_create::<u64>()?;
+    /// #     .typed::<u64>()
+    /// #     .open_or_create()?;
     /// #
     /// # let publisher = service.publisher().create()?;
     ///
@@ -705,7 +708,8 @@ impl<Service: service::Service, MessageType: Default + Debug> Publisher<Service,
     /// #
     /// # let service = zero_copy::Service::new(&service_name)
     /// #     .publish_subscribe()
-    /// #     .open_or_create::<u64>()?;
+    /// #     .typed::<u64>()
+    /// #     .open_or_create()?;
     /// #
     /// # let publisher = service.publisher().create()?;
     ///

iceoryx2/src/port/subscriber.rs

@@ -19,7 +19,8 @@
 //! let service_name = ServiceName::new("My/Funk/ServiceName")?;
 //! let service = zero_copy::Service::new(&service_name)
 //!     .publish_subscribe()
-//!     .open_or_create::<u64>()?;
+//!     .typed::<u64>()
+//!     .open_or_create()?;
 //!
 //! let subscriber = service.subscriber().create()?;
 //!

iceoryx2/src/port/update_connections.rs

@@ -49,7 +49,8 @@ pub trait UpdateConnections {
     /// #
     /// # let service = zero_copy::Service::new(&service_name)
     /// #     .publish_subscribe()
-    /// #     .open_or_create::<u64>()?;
+    /// #     .typed::<u64>()
+    /// #     .open_or_create()?;
     /// #
     /// # let publisher = service.publisher().create()?;
     ///

iceoryx2/src/sample.rs

@@ -18,7 +18,8 @@
 //! # let service_name = ServiceName::new("My/Funk/ServiceName")?;
 //! # let service = zero_copy::Service::new(&service_name)
 //! #   .publish_subscribe()
-//! #   .open_or_create::<u64>()?;
+//! #   .typed::<u64>()
+//! #   .open_or_create()?;
 //! # let subscriber = service.subscriber().create()?;
 //!
 //! while let Some(sample) = subscriber.receive()? {

iceoryx2/src/sample_mut.rs

@@ -19,7 +19,8 @@
 //! #
 //! # let service = zero_copy::Service::new(&service_name)
 //! #     .publish_subscribe()
-//! #     .open_or_create::<u64>()?;
+//! #     .typed::<u64>()
+//! #     .open_or_create()?;
 //! #
 //! # let publisher = service.publisher().create()?;
 //!
@@ -99,7 +100,8 @@ impl<MessageType: Debug, Service: crate::service::Service>
     /// #
     /// # let service = zero_copy::Service::new(&service_name)
     /// #     .publish_subscribe()
-    /// #     .open_or_create::<u64>()?;
+    /// #     .typed::<u64>()
+    /// #     .open_or_create()?;
     /// #
     /// # let publisher = service.publisher().create()?;
     ///
@@ -133,7 +135,8 @@ impl<MessageType: Debug, Service: crate::service::Service>
     /// #
     /// # let service = zero_copy::Service::new(&service_name)
     /// #     .publish_subscribe()
-    /// #     .open_or_create::<u64>()?;
+    /// #     .typed::<u64>()
+    /// #     .open_or_create()?;
     /// #
     /// # let publisher = service.publisher().create()?;
     ///
@@ -169,7 +172,8 @@ impl<
     /// #
     /// # let service = zero_copy::Service::new(&service_name)
     /// #     .publish_subscribe()
-    /// #     .open_or_create::<u64>()?;
+    /// #     .typed::<u64>()
+    /// #     .open_or_create()?;
     /// # let publisher = service.publisher().create()?;
     ///
     /// let sample = publisher.loan()?;
@@ -199,7 +203,8 @@ impl<
     /// #
     /// # let service = zero_copy::Service::new(&service_name)
     /// #     .publish_subscribe()
-    /// #     .open_or_create::<u64>()?;
+    /// #     .typed::<u64>()
+    /// #     .open_or_create()?;
     /// # let publisher = service.publisher().create()?;
     ///
     /// let sample = publisher.loan()?;
@@ -229,7 +234,8 @@ impl<
     /// #
     /// # let service = zero_copy::Service::new(&service_name)
     /// #     .publish_subscribe()
-    /// #     .open_or_create::<u64>()?;
+    /// #     .typed::<u64>()
+    /// #     .open_or_create()?;
     /// # let publisher = service.publisher().create()?;
     ///
     /// let mut sample = publisher.loan()?;