cyclonedds 3.0.0-alpha.3

Safe Rust wrapper for Eclipse CycloneDDS
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
use crate::{DdsError, DdsResult, DdsString};
use cyclonedds_rust_sys::{dds_alloc, dds_free};
use std::ffi::c_void;
use std::fmt;
use std::ptr;
use std::slice;

pub trait DdsSequenceElement: Clone + Sized + 'static {
    fn sequence_typecode() -> u32;
}

#[repr(C)]
pub struct DdsSequence<T> {
    pub(crate) _maximum: u32,
    pub(crate) _length: u32,
    pub(crate) _buffer: *mut T,
    pub(crate) _release: bool,
}

impl<T> DdsSequence<T> {
    pub const fn new() -> Self {
        Self {
            _maximum: 0,
            _length: 0,
            _buffer: ptr::null_mut(),
            _release: false,
        }
    }

    pub fn len(&self) -> usize {
        self._length as usize
    }

    pub fn is_empty(&self) -> bool {
        self._length == 0
    }

    pub fn as_slice(&self) -> &[T] {
        if self._buffer.is_null() || self._length == 0 {
            &[]
        } else {
            unsafe { slice::from_raw_parts(self._buffer.cast_const(), self.len()) }
        }
    }

    pub fn iter(&self) -> impl Iterator<Item = &T> {
        self.as_slice().iter()
    }
}

impl<T: Clone> DdsSequence<T> {
    pub fn from_slice(values: &[T]) -> DdsResult<Self> {
        if values.is_empty() {
            return Ok(Self::new());
        }

        let elem_size = std::mem::size_of::<T>();
        let total_size = values
            .len()
            .checked_mul(elem_size)
            .ok_or(DdsError::OutOfMemory)?;
        let buffer = unsafe { dds_alloc(total_size) as *mut T };
        if buffer.is_null() {
            return Err(DdsError::OutOfMemory);
        }

        for (idx, value) in values.iter().enumerate() {
            unsafe { ptr::write(buffer.add(idx), value.clone()) };
        }

        Ok(Self {
            _maximum: values.len() as u32,
            _length: values.len() as u32,
            _buffer: buffer,
            _release: true,
        })
    }

    /// # Safety
    ///
    /// `raw` must point to a valid CycloneDDS in-memory sequence instance whose
    /// buffer and length fields describe readable elements of type `T`.
    pub unsafe fn clone_from_raw(raw: *const Self) -> Self {
        let raw = &*raw;
        Self::from_slice(raw.as_slice()).expect("failed to clone DDS sequence")
    }

    pub fn to_vec(&self) -> Vec<T> {
        self.as_slice().to_vec()
    }
}

impl<T> DdsSequence<T> {
    /// Move `values` into a CycloneDDS-allocated buffer.
    ///
    /// Unlike [`DdsSequence::from_slice`] this takes ownership instead of
    /// cloning, so it works for element types that are not `Clone` — which is
    /// what the derive needs for `<Inner as DdsType>::Native`, a generated
    /// `#[repr(C)]` struct that owns `DdsString`/`DdsSequence` fields and
    /// therefore must not be duplicated. `Drop` already runs each element's
    /// destructor before freeing the buffer, so ownership transfers cleanly.
    pub fn from_vec(values: Vec<T>) -> DdsResult<Self> {
        if values.is_empty() {
            return Ok(Self::new());
        }

        let len = values.len();
        let total_size = len
            .checked_mul(std::mem::size_of::<T>())
            .ok_or(DdsError::OutOfMemory)?;
        let buffer = unsafe { dds_alloc(total_size) as *mut T };
        if buffer.is_null() {
            return Err(DdsError::OutOfMemory);
        }

        // Move out of `values` without running any destructor on the source:
        // the elements now belong to `buffer`.
        let mut values = std::mem::ManuallyDrop::new(values);
        unsafe {
            ptr::copy_nonoverlapping(values.as_ptr(), buffer, len);
            // Release the Vec's own allocation, whose elements have moved.
            let _ = Vec::from_raw_parts(values.as_mut_ptr(), 0, values.capacity());
        }

        Ok(Self {
            _maximum: len as u32,
            _length: len as u32,
            _buffer: buffer,
            _release: true,
        })
    }
}

impl<T> Default for DdsSequence<T> {
    fn default() -> Self {
        Self::new()
    }
}

impl<T: Clone> Clone for DdsSequence<T> {
    fn clone(&self) -> Self {
        Self::from_slice(self.as_slice()).expect("failed to clone DDS sequence")
    }
}

impl<T: PartialEq> PartialEq for DdsSequence<T> {
    fn eq(&self, other: &Self) -> bool {
        self.as_slice() == other.as_slice()
    }
}

impl<T: Eq> Eq for DdsSequence<T> {}

impl<T: fmt::Debug> fmt::Debug for DdsSequence<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("DdsSequence")
            .field(&self.as_slice())
            .finish()
    }
}

impl<T> Drop for DdsSequence<T> {
    fn drop(&mut self) {
        if !self._release || self._buffer.is_null() {
            return;
        }

        unsafe {
            if std::mem::needs_drop::<T>() {
                for idx in 0..self.len() {
                    ptr::drop_in_place(self._buffer.add(idx));
                }
            }
            dds_free(self._buffer as *mut c_void);
        }
    }
}

unsafe impl<T: Send> Send for DdsSequence<T> {}
unsafe impl<T: Sync> Sync for DdsSequence<T> {}

#[repr(C)]
pub struct DdsBoundedSequence<T, const N: usize> {
    pub(crate) _maximum: u32,
    pub(crate) _length: u32,
    pub(crate) _buffer: *mut T,
    pub(crate) _release: bool,
}

impl<T, const N: usize> DdsBoundedSequence<T, N> {
    pub const fn new() -> Self {
        Self {
            _maximum: N as u32,
            _length: 0,
            _buffer: ptr::null_mut(),
            _release: false,
        }
    }

    pub fn len(&self) -> usize {
        self._length as usize
    }

    pub fn is_empty(&self) -> bool {
        self._length == 0
    }

    pub fn as_slice(&self) -> &[T] {
        if self._buffer.is_null() || self._length == 0 {
            &[]
        } else {
            unsafe { slice::from_raw_parts(self._buffer.cast_const(), self.len()) }
        }
    }

    pub fn iter(&self) -> impl Iterator<Item = &T> {
        self.as_slice().iter()
    }
}

impl<T, const N: usize> DdsBoundedSequence<T, N> {
    /// Move `values` into a CycloneDDS-allocated buffer of `N` elements.
    ///
    /// The moving counterpart of [`DdsBoundedSequence::from_slice`]; see
    /// [`DdsSequence::from_vec`] for why the derive needs one.
    pub fn from_vec(values: Vec<T>) -> DdsResult<Self> {
        if values.len() > N {
            return Err(DdsError::BadParameter(format!(
                "bounded DDS sequence capacity exceeded: len={} bound={}",
                values.len(),
                N
            )));
        }

        if values.is_empty() {
            return Ok(Self::new());
        }

        let len = values.len();
        let total_size = N
            .checked_mul(std::mem::size_of::<T>())
            .ok_or(DdsError::OutOfMemory)?;
        let buffer = unsafe { dds_alloc(total_size) as *mut T };
        if buffer.is_null() {
            return Err(DdsError::OutOfMemory);
        }

        unsafe {
            std::ptr::write_bytes(buffer.cast::<u8>(), 0, total_size);
        }

        let mut values = std::mem::ManuallyDrop::new(values);
        unsafe {
            ptr::copy_nonoverlapping(values.as_ptr(), buffer, len);
            let _ = Vec::from_raw_parts(values.as_mut_ptr(), 0, values.capacity());
        }

        Ok(Self {
            _maximum: N as u32,
            _length: len as u32,
            _buffer: buffer,
            _release: true,
        })
    }
}

impl<T: Clone, const N: usize> DdsBoundedSequence<T, N> {
    pub fn from_slice(values: &[T]) -> DdsResult<Self> {
        if values.len() > N {
            return Err(DdsError::BadParameter(format!(
                "bounded DDS sequence capacity exceeded: len={} bound={}",
                values.len(),
                N
            )));
        }

        if values.is_empty() {
            return Ok(Self::new());
        }

        let elem_size = std::mem::size_of::<T>();
        let total_size = N.checked_mul(elem_size).ok_or(DdsError::OutOfMemory)?;
        let buffer = unsafe { dds_alloc(total_size) as *mut T };
        if buffer.is_null() {
            return Err(DdsError::OutOfMemory);
        }

        unsafe {
            std::ptr::write_bytes(buffer.cast::<u8>(), 0, total_size);
        }

        for (idx, value) in values.iter().enumerate() {
            unsafe { ptr::write(buffer.add(idx), value.clone()) };
        }

        Ok(Self {
            _maximum: N as u32,
            _length: values.len() as u32,
            _buffer: buffer,
            _release: true,
        })
    }

    /// # Safety
    ///
    /// `raw` must point to a valid CycloneDDS in-memory bounded sequence
    /// instance whose buffer and length fields describe readable elements of
    /// type `T`.
    pub unsafe fn clone_from_raw(raw: *const Self) -> Self {
        let raw = &*raw;
        Self::from_slice(raw.as_slice()).expect("failed to clone bounded DDS sequence")
    }

    pub fn to_vec(&self) -> Vec<T> {
        self.as_slice().to_vec()
    }
}

impl<T, const N: usize> Default for DdsBoundedSequence<T, N> {
    fn default() -> Self {
        Self::new()
    }
}

impl<T: Clone, const N: usize> Clone for DdsBoundedSequence<T, N> {
    fn clone(&self) -> Self {
        Self::from_slice(self.as_slice()).expect("failed to clone bounded DDS sequence")
    }
}

impl<T: PartialEq, const N: usize> PartialEq for DdsBoundedSequence<T, N> {
    fn eq(&self, other: &Self) -> bool {
        self.as_slice() == other.as_slice()
    }
}

impl<T: Eq, const N: usize> Eq for DdsBoundedSequence<T, N> {}

impl<T: fmt::Debug, const N: usize> fmt::Debug for DdsBoundedSequence<T, N> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("DdsBoundedSequence")
            .field(&self.as_slice())
            .finish()
    }
}

impl<T, const N: usize> Drop for DdsBoundedSequence<T, N> {
    fn drop(&mut self) {
        if !self._release || self._buffer.is_null() {
            return;
        }

        unsafe {
            if std::mem::needs_drop::<T>() {
                for idx in 0..self.len() {
                    ptr::drop_in_place(self._buffer.add(idx));
                }
            }
            dds_free(self._buffer as *mut c_void);
        }
    }
}

unsafe impl<T: Send, const N: usize> Send for DdsBoundedSequence<T, N> {}
unsafe impl<T: Sync, const N: usize> Sync for DdsBoundedSequence<T, N> {}

macro_rules! impl_primitive_sequence_element {
    ($ty:ty, $typecode:expr) => {
        impl DdsSequenceElement for $ty {
            fn sequence_typecode() -> u32 {
                $typecode
            }
        }
    };
}

impl_primitive_sequence_element!(
    i8,
    crate::TYPE_SEQ | crate::SUBTYPE_1BY | crate::OP_FLAG_SGN
);
impl_primitive_sequence_element!(u8, crate::TYPE_SEQ | crate::SUBTYPE_1BY);
impl_primitive_sequence_element!(
    i16,
    crate::TYPE_SEQ | crate::SUBTYPE_2BY | crate::OP_FLAG_SGN
);
impl_primitive_sequence_element!(u16, crate::TYPE_SEQ | crate::SUBTYPE_2BY);
impl_primitive_sequence_element!(
    i32,
    crate::TYPE_SEQ | crate::SUBTYPE_4BY | crate::OP_FLAG_SGN
);
impl_primitive_sequence_element!(u32, crate::TYPE_SEQ | crate::SUBTYPE_4BY);
impl_primitive_sequence_element!(
    i64,
    crate::TYPE_SEQ | crate::SUBTYPE_8BY | crate::OP_FLAG_SGN
);
impl_primitive_sequence_element!(u64, crate::TYPE_SEQ | crate::SUBTYPE_8BY);
impl_primitive_sequence_element!(
    f32,
    crate::TYPE_SEQ | crate::SUBTYPE_4BY | crate::OP_FLAG_FP
);
impl_primitive_sequence_element!(
    f64,
    crate::TYPE_SEQ | crate::SUBTYPE_8BY | crate::OP_FLAG_FP
);
impl_primitive_sequence_element!(bool, crate::TYPE_SEQ | crate::SUBTYPE_1BY);
impl_primitive_sequence_element!(DdsString, crate::TYPE_SEQ | crate::SUBTYPE_STR);