Struct EntityIDRecord

pub struct EntityIDRecord {
    pub simulation_address_record: SimulationAddressRecord,
    pub entity_identifier_field: u16,
}

Entity ID Record as defined in IEEE 1278.1 standard. Used to communicate the ID of an entity during the simulation.

Fields

simulation_address_record: SimulationAddressRecord

entity_identifier_field: u16

Implementations

impl EntityIDRecord

pub fn new( site_identifier_field: u16, application_identifier_field: u16, entity_identifier_field: u16, ) -> Self

Provides a function to create a new EntityIDRecord. Enforces all entity IDs must be non-zero.

Examples

Creating a new EntityIDRecord at site 1, on application 1, with entity ID 1:

let entity_id_record = EntityIDRecord::new{
    site_identifier_field: 1,
    application_identifier_field: 1
    entity_identifier_field: 1
};

pub fn default(entity_identifier: u16) -> Self

Provides a function to create a default EntityIDRecord. Uses the default SimulationAddressRecord. Enforces all entity IDs must be non-zero.

Examples

Creating a default EntityIDRecord with event ID 2:

let entity_id_record = EntityIDRecord::default(2);

pub fn serialize(&self, buf: &mut BytesMut)

Fills a BytesMut struct with a EntityIDRecord serialised into binary. This buffer is then ready to be sent via UDP to the simluation network.

pub fn decode(buf: &mut BytesMut) -> EntityIDRecord

Trait Implementations

impl Clone for EntityIDRecord

fn clone(&self) -> EntityIDRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityIDRecord

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

Formats the value using the given formatter.

impl Default for EntityIDRecord

fn default() -> EntityIDRecord

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EntityIDRecord

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EntityIDRecord

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EntityIDRecord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for EntityIDRecord

impl StructuralPartialEq for EntityIDRecord