Skip to main content

CuSceneExclusions

Struct CuSceneExclusions 

Source
pub struct CuSceneExclusions<const MAX_EXCLUSIONS: usize = DEFAULT_MAX_EXCLUSIONS> { /* private fields */ }
Expand description

Fixed-capacity stable-ID exclusion set (CuMsgPayload-compliant).

Published alongside a CuPlanningScene snapshot and validated against it on every check, so exclusions always bind to the current snapshot.

Implementations§

Source§

impl<const MAX_EXCLUSIONS: usize> CuSceneExclusions<MAX_EXCLUSIONS>

Source

pub const fn new() -> Self

Creates an empty exclusion set.

Source

pub const fn len(&self) -> usize

Returns the number of active exclusions.

Source

pub const fn is_empty(&self) -> bool

Returns true if no exclusions are active.

Source

pub const fn capacity(&self) -> usize

Returns the maximum number of exclusions.

Source

pub fn as_slice(&self) -> &[CuSceneExclusion]

Borrows the active exclusions.

Source

pub fn add(&mut self, exclusion: CuSceneExclusion) -> CuResult<()>

Appends an exclusion if capacity permits.

Source

pub fn clear(&mut self)

Removes all exclusions in place.

Source

pub fn validate<const MAX_OBS: usize, const MAX_ATT: usize>( &self, scene: &CuPlanningScene<MAX_OBS, MAX_ATT>, robot_shape_count: usize, ) -> CuResult<()>

Checks every entry against scene and a robot model with robot_shape_count shapes.

Unassigned or unknown IDs, self-references, and out-of-range robot shape indices fail. Checks perform the same validation; this lets a caller reject a snapshot up front.

Trait Implementations§

Source§

impl<'de, C, const MAX_EXCLUSIONS: usize> BorrowDecode<'de, C> for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

fn borrow_decode<D: BorrowDecoder<'de, Context = C>>( decoder: &mut D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.
Source§

impl<const MAX_EXCLUSIONS: usize> Clone for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

fn clone(&self) -> CuSceneExclusions<MAX_EXCLUSIONS>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<const MAX_EXCLUSIONS: usize> Debug for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<C, const MAX_EXCLUSIONS: usize> Decode<C> for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

fn decode<D: Decoder<Context = C>>(decoder: &mut D) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.
Source§

impl<const MAX_EXCLUSIONS: usize> Default for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de, const MAX_EXCLUSIONS: usize> Deserialize<'de> for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<const MAX_EXCLUSIONS: usize> Encode for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

fn encode<E: Encoder>(&self, encoder: &mut E) -> Result<(), EncodeError>

Encode a given type.
Source§

impl<const MAX_EXCLUSIONS: usize> PartialEq for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

fn eq(&self, other: &CuSceneExclusions<MAX_EXCLUSIONS>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<const MAX_EXCLUSIONS: usize> Serialize for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<const MAX_EXCLUSIONS: usize> StructuralPartialEq for CuSceneExclusions<MAX_EXCLUSIONS>

Source§

impl<const MAX_EXCLUSIONS: usize> TypePath for CuSceneExclusions<MAX_EXCLUSIONS>

§

fn type_path() -> &'static str

§

fn short_type_path() -> &'static str

§

fn type_ident() -> Option<&'static str>

§

fn crate_name() -> Option<&'static str>

§

fn module_path() -> Option<&'static str>

Auto Trait Implementations§

§

impl<const MAX_EXCLUSIONS: usize> Freeze for CuSceneExclusions<MAX_EXCLUSIONS>

§

impl<const MAX_EXCLUSIONS: usize> RefUnwindSafe for CuSceneExclusions<MAX_EXCLUSIONS>

§

impl<const MAX_EXCLUSIONS: usize> Send for CuSceneExclusions<MAX_EXCLUSIONS>

§

impl<const MAX_EXCLUSIONS: usize> Sync for CuSceneExclusions<MAX_EXCLUSIONS>

§

impl<const MAX_EXCLUSIONS: usize> Unpin for CuSceneExclusions<MAX_EXCLUSIONS>

§

impl<const MAX_EXCLUSIONS: usize> UnsafeUnpin for CuSceneExclusions<MAX_EXCLUSIONS>

§

impl<const MAX_EXCLUSIONS: usize> UnwindSafe for CuSceneExclusions<MAX_EXCLUSIONS>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> CuMsgPayload for T
where T: Default + Debug + Clone + Encode + Decode<()> + Serialize + DeserializeOwned + Reflect,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> GetTypeRegistration for T

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PayloadDefaultHandlePolicyApply for T
where T: ?Sized,

§

fn apply_handle_content_policy(&self, _mode: HandleContent)

§

impl<T> PayloadDefaultLoggingPolicy for T
where T: ?Sized,

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Reflect for T
where T: 'static,

§

impl<T> ReflectTypePath for T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.