Struct Header 

pub struct Header {

    pub sdo_id: SdoId,
    pub version: PtpVersion,
    pub domain_number: u8,
    pub alternate_master_flag: bool,
    pub two_step_flag: bool,
    pub unicast_flag: bool,
    pub ptp_profile_specific_1: bool,
    pub ptp_profile_specific_2: bool,
    pub leap61: bool,
    pub leap59: bool,
    pub current_utc_offset_valid: bool,
    pub ptp_timescale: bool,
    pub time_tracable: bool,
    pub frequency_tracable: bool,
    pub synchronization_uncertain: bool,
    pub correction_field: TimeInterval,
    pub source_port_identity: PortIdentity,
    pub sequence_id: u16,
    pub log_message_interval: i8,
}

The header of a PTP version 2 message.

For more details, see IEEE1588-2019 section 13.3.

Fields

sdo_id: SdoId

Sdo ID of the profile in use for the message.

version: PtpVersion

Specific version of PTP for this message.

domain_number: u8

The domain number of the message.

This is used to allow multiple PTP setups to run within the same network without interfering with each other.

alternate_master_flag: bool

Indicates whether the sender is an alternate master.

This is used with the Grandmaster Cluster and Alternate Master optional PTP features. For more details, see IEEE1588-2019 sections 17.2 and17.3

two_step_flag: bool

Indicates whether the message is part of a two-step time transmission.

unicast_flag: bool

Indicates whether the message is sent via a unicast connection.

ptp_profile_specific_1: bool

Used for PTP profile-specific information.

ptp_profile_specific_2: bool

Used for PTP profile-specific information.

leap61: bool

In announce messages, indicates whether the last minute of the current UTC day shall have 61 seconds.

leap59: bool

In announce messages, indicates whether the last minute of the current UTC day shall have 59 seconds.

current_utc_offset_valid: bool

In announce messages, indicates whether the offset between UTC and TAI is valid.

ptp_timescale: bool

In announce messages, indicates whether the timescale is TAI (when true), or something else.

time_tracable: bool

In announce messages, indicates whether the time provided is traceable in the metrology sense.

frequency_tracable: bool

In announce messages, indicates whether the frequency provided is traceable in the metrology sense.

synchronization_uncertain: bool

In announce messages, a true value indicates that the time provider may not itself be properly synchronized.

correction_field: TimeInterval

Correction field to the timestamps in event messages.

This is used to improve the precision of those timestamps, as well as to allow for compensating for the dwell time of messages in switches.

source_port_identity: PortIdentity

Identity of the PTP port that sent this message.

sequence_id: u16

Rolling sequence id for the message.

log_message_interval: i8

Used for communication of message sending intervals for some messages

See IEEE1588 Table 42 in section 13.3.2.14 for more details.

Implementations

impl Header

pub fn new(minor_ptp_version: u8) -> Self

Get a new header initialized with default values for all of the fields.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Header

impl Debug for Header

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

Formats the value using the given formatter.

impl Eq for Header

impl PartialEq for Header

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Header