Skip to main content

LinkMetadata

Struct LinkMetadata 

Source
pub struct LinkMetadata {
    pub dbf_type: Option<LinkDbfType>,
    pub element_count: Option<i64>,
    pub graphic_limits: Option<(f64, f64)>,
    pub control_limits: Option<(f64, f64)>,
    pub alarm_limits: Option<(f64, f64, f64, f64)>,
    pub precision: Option<i16>,
    pub units: Option<String>,
    pub description: Option<String>,
}
Expand description

Remote display / control / valueAlarm metadata snapshot for a link, as exposed by pvxs’s pvalink lset metadata getters.

Mirrors the pvxs pvalink_lset.cpp metadata getter set installed at pvxs/ioc/pvalink_lset.cpp:700: pvaGetDBFtype, pvaGetElements, pvaGetControlLimits, pvaGetGraphicLimits, pvaGetAlarmLimits, pvaGetPrecision, pvaGetUnits.

Every field is optional: pvxs’s getters read the cached NT structure with Value::as, which leaves the caller’s buffer unchanged when the sub-field is absent. None here means the remote NT value carried no such metadata — the record support then keeps its local/default metadata, exactly as the C path does.

Fields§

§dbf_type: Option<LinkDbfType>

DBF type the remote value maps to (pvaGetDBFtype). A connected link always reports a type — an unmappable value shape falls back to Long, the default: arm of pvxs pvaGetDBFtype (pvalink_lset.cpp:199-236). None therefore means “not connected” (no cached value), never “connected but unmappable”.

§element_count: Option<i64>

Element count: array length, or 1 for a scalar / any connected non-array shape (pvaGetElements, pvalink_lset.cpp:242-254). As with dbf_type, None means “not connected”.

§graphic_limits: Option<(f64, f64)>

display.limitLow / display.limitHigh (pvaGetGraphicLimits).

§control_limits: Option<(f64, f64)>

control.limitLow / control.limitHigh (pvaGetControlLimits).

§alarm_limits: Option<(f64, f64, f64, f64)>

valueAlarm.{lowAlarmLimit,lowWarningLimit,highWarningLimit, highAlarmLimit} as (lolo, lo, hi, hihi) (pvaGetAlarmLimits).

§precision: Option<i16>

display.precision (pvaGetPrecision).

§units: Option<String>

display.units (pvaGetUnits).

§description: Option<String>

display.description — carried so a link snapshot is complete; pvxs exposes it through the same fld_meta cache.

Trait Implementations§

Source§

impl Clone for LinkMetadata

Source§

fn clone(&self) -> LinkMetadata

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 Debug for LinkMetadata

Source§

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

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

impl Default for LinkMetadata

Source§

fn default() -> LinkMetadata

Returns the “default value” for a type. Read more
Source§

impl PartialEq for LinkMetadata

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StructuralPartialEq for LinkMetadata

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more