Struct sacn_unofficial::receive::DMXData

pub struct DMXData {
    pub universe: u16,
    pub values: Vec<u8>,
    pub sync_uni: u16,
    pub priority: u8,
    pub src_cid: Option<Uuid>,
    pub preview: bool,
    pub recv_timestamp: Instant,
}

Holds a universes worth of DMX data.

Fields

universe: u16

The universe that the data was sent to.

values: Vec<u8>

The actual universe data, if less than 512 values in length then implies trailing 0's to pad to a full-universe of data.

sync_uni: u16

The universe the data is (or was if now acted upon) waiting for a synchronisation packet from. 0 indicates it isn't waiting for a universe synchronisation packet.

priority: u8

The priority of the data, this may be useful for receivers which want to implement their own implementing merge algorithms. Must be less than packet::E131_MAX_PRIORITY.

src_cid: Option<Uuid>

The unique id of the source of the data, this may be useful for receivers which want to implement their own merge algorithms which use the identity of the source to decide behaviour. A value of None indicates that there is no clear source, for example if a merge algorithm has merged data from 2 or more sources together.

preview: bool

Indicates if the data is marked as 'preview' data indicating it is for use by visualisers etc. as per ANSI E1.31-2018 Section 6.2.6.

recv_timestamp: Instant

The timestamp that the data was received.

Trait Implementations

impl Clone for DMXData

pub fn clone(&self) -> DMXData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DMXData

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

Formats the value using the given formatter.

impl Eq for DMXData

See PartialEq trait implementation for DMXData.

impl Ord for DMXData

DMXData has a total ordering based on the universe, then sync-universe and finally values.

pub fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<DMXData> for DMXData

DMXData is taken to be equivalent iff: - The universes are the same - The synchronisation universes are the same - The values are all the same

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<DMXData> for DMXData

See Ord trait implementation for DMXData.

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.