Skip to main content

PhaseLockLoopUpdate

Struct PhaseLockLoopUpdate 

Source
pub struct PhaseLockLoopUpdate {
    pub applied: bool,
    pub locked: bool,
    pub rejected_outlier: bool,
    pub freq_trim_mppb: i64,
    pub phase_corr_ns: i64,
    pub p_corr_ns: i64,
    pub d_corr_ns: i64,
    pub predicted_phase_ns: i64,
}
Expand description

Result of PhaseLockLoop::update. The caller forms the output period from freq_trim_mppb (added to the crystal estimate) and phase_corr_ns; the rest is for logging.

Fields§

§applied: bool

Whether this edge was applied (false if invalid or rejected as an outlier).

§locked: bool

Lock state used for this edge’s control decisions (lock attained on a prior edge).

§rejected_outlier: bool

Whether this edge was held as a post-lock outlier.

§freq_trim_mppb: i64

Integrated frequency trim (milli-ppb) to add to the crystal’s estimated offset.

§phase_corr_ns: i64

Immediate phase correction (ns) to subtract from this period (= p_corr_ns + d_corr_ns).

§p_corr_ns: i64

Proportional component of phase_corr_ns (ns).

§d_corr_ns: i64

Derivative component of phase_corr_ns (ns).

§predicted_phase_ns: i64

The Smith-predicted phase used as the control input this edge (ns).

Trait Implementations§

Source§

impl Clone for PhaseLockLoopUpdate

Source§

fn clone(&self) -> PhaseLockLoopUpdate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PhaseLockLoopUpdate

Source§

impl Debug for PhaseLockLoopUpdate

Source§

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

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

impl Eq for PhaseLockLoopUpdate

Source§

impl PartialEq for PhaseLockLoopUpdate

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PhaseLockLoopUpdate

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.