[eclipse-iceoryx#210] Fix node and service name C API

iceoryx2-ffi/cxx/src/node_name.cpp

@@ -20,13 +20,13 @@
 namespace iox2 {
 auto NodeNameView::to_string() const -> iox::string<IOX2_NODE_NAME_LENGTH> {
     size_t len = 0;
-    const auto* c_ptr = iox2_node_name_as_c_str(m_ptr, &len);
+    const auto* c_ptr = iox2_node_name_as_str(m_ptr, &len);
     return { iox::TruncateToCapacity, c_ptr, len };
 }
 
 auto NodeNameView::to_owned() const -> NodeName {
     size_t len = 0;
-    const auto* c_ptr = iox2_node_name_as_c_str(m_ptr, &len);
+    const auto* c_ptr = iox2_node_name_as_str(m_ptr, &len);
     return NodeName::create_impl(c_ptr, len).expect("NodeNameView contains always valid NodeName");
 }
 
@@ -68,7 +68,7 @@ auto NodeName::operator=(const NodeName& rhs) -> NodeName& {
 
         const auto* ptr = iox2_cast_node_name_ptr(rhs.m_handle);
         size_t len = 0;
-        const auto* c_ptr = iox2_node_name_as_c_str(ptr, &len);
+        const auto* c_ptr = iox2_node_name_as_str(ptr, &len);
         IOX_ASSERT(iox2_node_name_new(nullptr, c_ptr, len, &m_handle) == IOX2_OK,
                    "NodeName shall always contain a valid value.");
     }

iceoryx2-ffi/cxx/src/service_name.cpp

@@ -19,13 +19,13 @@
 namespace iox2 {
 auto ServiceNameView::to_string() const -> iox::string<IOX2_NODE_NAME_LENGTH> {
     size_t len = 0;
-    const auto* c_ptr = iox2_service_name_as_c_str(m_ptr, &len);
+    const auto* c_ptr = iox2_service_name_as_str(m_ptr, &len);
     return { iox::TruncateToCapacity, c_ptr, len };
 }
 
 auto ServiceNameView::to_owned() const -> ServiceName {
     size_t len = 0;
-    const auto* c_ptr = iox2_service_name_as_c_str(m_ptr, &len);
+    const auto* c_ptr = iox2_service_name_as_str(m_ptr, &len);
     return ServiceName::create_impl(c_ptr, len).expect("ServiceNameView always contains valid ServiceName");
 }
 
@@ -67,7 +67,7 @@ auto ServiceName::operator=(const ServiceName& rhs) -> ServiceName& {
 
         const auto* ptr = iox2_cast_service_name_ptr(rhs.m_handle);
         size_t len = 0;
-        const auto* c_ptr = iox2_service_name_as_c_str(ptr, &len);
+        const auto* c_ptr = iox2_service_name_as_str(ptr, &len);
         IOX_ASSERT(iox2_service_name_new(nullptr, c_ptr, len, &m_handle) == IOX2_OK,
                    "ServiceName shall always contain a valid value.");
     }

iceoryx2-ffi/ffi/src/api/node_name.rs

@@ -158,24 +158,26 @@ pub unsafe extern "C" fn iox2_cast_node_name_ptr(
     (*node_name_handle.as_type()).value.as_ref()
 }
 
-/// This function gives access to the node name as a C-style string
+/// This function gives access to the node name as a non-zero-terminated char string
 ///
 /// # Arguments
 ///
 /// * `node_name_ptr` obtained by e.g. [`iox2_cast_node_name_ptr`] or a function returning a [`iox2_node_name_ptr`]
-/// * `node_name_len` can be used to get the length of the C-style string if not `NULL`
+/// * `node_name_len` must be used to get the length of the char string
 ///
-/// Returns zero terminated C-style string
+/// Returns a non-zero-terminated char string
 ///
 /// # Safety
 ///
 /// * The `node_name_ptr` must be a valid pointer to a node name.
+/// * The `node_name_len` must be a valid pointer to a size_t.
 #[no_mangle]
-pub unsafe extern "C" fn iox2_node_name_as_c_str(
+pub unsafe extern "C" fn iox2_node_name_as_str(
     node_name_ptr: iox2_node_name_ptr,
     node_name_len: *mut c_size_t,
 ) -> *const c_char {
     debug_assert!(!node_name_ptr.is_null());
+    debug_assert!(!node_name_len.is_null());
 
     let node_name = &*node_name_ptr;
 

iceoryx2-ffi/ffi/src/api/service_name.rs

@@ -158,24 +158,26 @@ pub unsafe extern "C" fn iox2_cast_service_name_ptr(
     (*service_name_handle.as_type()).value.as_ref()
 }
 
-/// This function gives access to the node name as a C-style string
+/// This function gives access to the node name as a non-zero-terminated char string
 ///
 /// # Arguments
 ///
 /// * `service_name_ptr` obtained by e.g. [`iox2_cast_service_name_ptr`] or a function returning a [`iox2_service_name_ptr`]
-/// * `service_name_len` can be used to get the length of the C-style string if not `NULL`
+/// * `service_name_len` must be used to get the length of the char string
 ///
-/// Returns zero terminated C-style string
+/// Returns non-zero-terminated char string
 ///
 /// # Safety
 ///
 /// * The `service_name_ptr` must be a valid pointer to a node name.
+/// * The `service_name_len` must be a valid pointer to a size_t.
 #[no_mangle]
-pub unsafe extern "C" fn iox2_service_name_as_c_str(
+pub unsafe extern "C" fn iox2_service_name_as_str(
     service_name_ptr: iox2_service_name_ptr,
     service_name_len: *mut c_size_t,
 ) -> *const c_char {
     debug_assert!(!service_name_ptr.is_null());
+    debug_assert!(!service_name_len.is_null());
 
     let service_name = &*service_name_ptr;
 

iceoryx2-ffi/ffi/src/tests/node_name_tests.rs

@@ -29,12 +29,12 @@ fn basic_node_name_test() -> Result<(), Box<dyn std::error::Error>> {
         assert_that!(ret_val, eq(IOX2_OK));
 
         let mut node_name_len = 0;
-        let node_name_c_str = iox2_node_name_as_c_str(
+        let node_name_c_ptr = iox2_node_name_as_str(
             iox2_cast_node_name_ptr(node_name_handle),
             &mut node_name_len,
         );
 
-        let slice = slice::from_raw_parts(node_name_c_str as *const _, node_name_len as _);
+        let slice = slice::from_raw_parts(node_name_c_ptr as *const _, node_name_len as _);
         let node_name = str::from_utf8(slice)?;
 
         assert_that!(node_name, eq(expected_node_name.as_str()));

iceoryx2-ffi/ffi/src/tests/node_tests.rs

@@ -51,9 +51,9 @@ mod node {
             let node_name = iox2_node_name(iox2_cast_node_ref_h(node_handle));
 
             let mut node_name_len = 0;
-            let node_name_c_str = iox2_node_name_as_c_str(node_name, &mut node_name_len);
+            let node_name_c_ptr = iox2_node_name_as_str(node_name, &mut node_name_len);
 
-            let slice = slice::from_raw_parts(node_name_c_str as *const _, node_name_len as _);
+            let slice = slice::from_raw_parts(node_name_c_ptr as *const _, node_name_len as _);
             let node_name_str = str::from_utf8(slice)?;
 
             assert_that!(node_name_str, eq("hypnotoad"));

iceoryx2-ffi/ffi/src/tests/service_name_tests.rs

@@ -29,12 +29,12 @@ fn basic_service_name_test() -> Result<(), Box<dyn std::error::Error>> {
         assert_that!(ret_val, eq(IOX2_OK));
 
         let mut service_name_len = 0;
-        let service_name_c_str = iox2_service_name_as_c_str(
+        let service_name_c_ptr = iox2_service_name_as_str(
             iox2_cast_service_name_ptr(service_name_handle),
             &mut service_name_len,
         );
 
-        let slice = slice::from_raw_parts(service_name_c_str as *const _, service_name_len as _);
+        let slice = slice::from_raw_parts(service_name_c_ptr as *const _, service_name_len as _);
         let service_name = str::from_utf8(slice)?;
 
         assert_that!(service_name, eq(expected_service_name.as_str()));