Enum rustdds::InstanceState

#[repr(u32)]
pub enum InstanceState {
    Alive,
    NotAliveDisposed,
    NotAliveNoWriters,
}

Is this data instance alive or not and why.

The instance_state available in the SampleInfo is a snapshot of the instance_state of the instance at the time the collection was obtained (i.e., at the time read or take was called). The instance_state is therefore be the same for all samples in the returned collection that refer to the same instance.

DDS spec v1.4 Section “2.2.2.5.1.3 Interpretation of the SampleInfo instance_state”

Variants

Alive

indicates that (a) samples have been received for the instance, (b) there are live DataWriter entities writing the instance, and (c) the instance has not been explicitly disposed (or else more samples have been received after it was disposed).

NotAliveDisposed

indicates the instance was explicitly disposed by a DataWriter by means of the dispose operation.

NotAliveNoWriters

indicates the instance has been declared as not-alive by the DataReader because it detected that there are no live DataWriter entities writing that instance

Implementations

impl InstanceState

pub fn any() -> BitFlags<Self>

Set that contains all possible states

pub fn not_alive() -> BitFlags<Self>

Set that contains both not_alive states.

Trait Implementations

impl BitAnd<InstanceState> for InstanceState

type Output = BitFlags<InstanceState>

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self::Output

Performs the & operation.

impl BitOr<InstanceState> for InstanceState

type Output = BitFlags<InstanceState>

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self::Output

Performs the | operation.

impl BitXor<InstanceState> for InstanceState

type Output = BitFlags<InstanceState>

The resulting type after applying the ^ operator.

fn bitxor(self, other: Self) -> Self::Output

Performs the ^ operation.

impl Clone for InstanceState

fn clone(&self) -> InstanceState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceState

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

Formats the value using the given formatter.

impl Not for InstanceState

type Output = BitFlags<InstanceState>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<InstanceState> for InstanceState

fn eq(&self, other: &InstanceState) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl RawBitFlags for InstanceState

type Type = u32

The underlying integer type.

fn all() -> Self::Type

Return a value with all flag bits set.

fn bits(self) -> Self::Type

Return the bits as a number type.

fn flag_list() -> &'static [Self]

Return a slice that contains each variant exactly one.

fn bitflags_type_name() -> &'static str

Return the name of the type for debug formatting purposes.

impl Copy for InstanceState

impl RawBitFlags for InstanceState

impl StructuralPartialEq for InstanceState