Skip to main content

Stratum

Struct Stratum 

Source
pub struct Stratum(pub u8);
Expand description

An 8-bit integer representing the stratum.

+--------+-----------------------------------------------------+
| Value  | Meaning                                             |
+--------+-----------------------------------------------------+
| 0      | unspecified or invalid                              |
| 1      | primary server (e.g., equipped with a GPS receiver) |
| 2-15   | secondary server (via NTP)                          |
| 16     | unsynchronized                                      |
| 17-255 | reserved                                            |
+--------+-----------------------------------------------------+

It is customary to map the stratum value 0 in received packets to MAXSTRAT in the peer variable p.stratum and to map p.stratum values of MAXSTRAT or greater to 0 in transmitted packets. This allows reference clocks, which normally appear at stratum 0, to be conveniently mitigated using the same clock selection algorithms used for external sources.

Tuple Fields§

§0: u8

Implementations§

Source§

impl Stratum

Source

pub const UNSPECIFIED: Self

Unspecified or invalid.

Source

pub const PRIMARY: Self

The primary server (e.g. equipped with a GPS receiver.

Source

pub const SECONDARY_MIN: Self

The minimum value specifying a secondary server (via NTP).

Source

pub const SECONDARY_MAX: Self

The maximum value specifying a secondary server (via NTP).

Source

pub const UNSYNCHRONIZED: Self

An unsynchronized stratum.

Source

pub const MAX: Self

The maximum valid stratum value.

Source

pub fn is_secondary(&self) -> bool

Whether or not the stratum represents a secondary server.

Source

pub fn is_reserved(&self) -> bool

Whether or not the stratum is in the reserved range.

Trait Implementations§

Source§

impl Clone for Stratum

Source§

fn clone(&self) -> Stratum

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ConstPackedSizeBytes for Stratum

Source§

const PACKED_SIZE_BYTES: usize = 1

The constant size in bytes when this type is packed for network transmission.
Source§

impl Debug for Stratum

Source§

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

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

impl FromBytes for Stratum

Source§

fn from_bytes(buf: &[u8]) -> Result<(Self, usize), ParseError>

Parse from the given byte slice. Returns the parsed value and the number of bytes consumed from the front of buf.
Source§

impl Hash for Stratum

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Stratum

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Stratum

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for Stratum

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl ReadFromBytes for Stratum

Available on crate feature std only.
Source§

fn read_from_bytes<R: ReadBytesExt>(reader: R) -> Result<Self>

Read the command from bytes.
Source§

impl ToBytes for Stratum

Source§

fn to_bytes(&self, buf: &mut [u8]) -> Result<usize, ParseError>

Write this value into the given byte slice. Returns the number of bytes written. Fails with ParseError::BufferTooShort if buf is too short.
Source§

impl WriteToBytes for Stratum

Available on crate feature std only.
Source§

fn write_to_bytes<W: WriteBytesExt>(&self, writer: W) -> Result<()>

Write the command to bytes.
Source§

impl Copy for Stratum

Source§

impl Eq for Stratum

Source§

impl StructuralPartialEq for Stratum

Auto Trait Implementations§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.