carla 0.14.1

Rust client library for Carla simulator
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

use core::slice;
use std::marker::PhantomData;

use carla_sys::carla_rust::client::FfiActorAttributeValueList;
use cxx::UniquePtr;
use derivative::Derivative;

use super::ActorAttributeValue;

/// The list of actor attribute values on an actor.
#[derive(Derivative)]
#[derivative(Debug)]
#[repr(transparent)]
pub struct ActorAttributeValueList<'a> {
    #[derivative(Debug = "ignore")]
    inner: UniquePtr<FfiActorAttributeValueList>,
    _phantom: PhantomData<&'a ()>,
}

impl<'a> ActorAttributeValueList<'a> {
    pub fn len(&self) -> usize {
        self.inner.len()
    }

    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    pub fn as_slice(&self) -> &[ActorAttributeValue] {
        unsafe {
            // SAFETY: ActorAttributeValue is repr(transparent) and has the same layout
            // as the underlying C++ type. This is guaranteed by the FFI bindings.
            slice::from_raw_parts(self.inner.data() as *const ActorAttributeValue, self.len())
        }
    }

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

    pub(crate) unsafe fn from_cxx(ptr: UniquePtr<FfiActorAttributeValueList>) -> Option<Self> {
        if ptr.is_null() {
            None
        } else {
            Some(Self {
                inner: ptr,
                _phantom: PhantomData,
            })
        }
    }
}