Skip to main content

FeatureState

Struct FeatureState 

Source
pub struct FeatureState {
    pub value: Value,
    pub access_mode: String,
    pub kind: String,
    pub is_implemented: bool,
    pub is_available: bool,
    pub numeric: Option<NumericRange>,
    pub enum_available: Option<Vec<String>>,
    pub unit: Option<String>,
}
Expand description

Live state of a GenICam feature at a single point in time.

Replaces NodeValueUpdate as the authoritative snapshot consumed by the UI. Every field reflects what the device reports now, not what the XML declares statically.

§Design notes

  • kind is a plain string matching viva_genapi::Node::kind_name values (“Integer”, “Float”, “Enumeration”, “Boolean”, “Command”, “Category”, “SwissKnife”, “Converter”, “IntConverter”, “StringReg”, “Register”). Clients should tolerate unknown kinds.
  • access_mode uses GenICam spelling: "RO", "RW", "WO", "NA".
  • is_implemented and is_available default to true for deserialization from services that do not evaluate these predicates yet.
  • numeric is Some only for Integer/Float nodes with a resolvable range.
  • enum_available is Some only for Enumeration nodes. When the service cannot filter by IsAvailable it SHOULD still populate this with the full entry list so the UI stops falling back to static XML.

Fields§

§value: Value

Current feature value, typed according to kind.

§access_mode: String

Live access mode.

§kind: String

GenICam node kind.

§is_implemented: bool

Whether the node is implemented by the device.

§is_available: bool

Whether the node is currently accessible (selector gating etc).

§numeric: Option<NumericRange>

Range for Integer/Float nodes, when resolvable.

§enum_available: Option<Vec<String>>

Available enum entries for Enumeration nodes.

§unit: Option<String>

Engineering unit copied from node metadata (e.g. "us").

Implementations§

Source§

impl FeatureState

Source

pub fn to_node_value_update(&self) -> NodeValueUpdate

Project this state into the legacy NodeValueUpdate shape so callers that still speak the old contract keep working during migration.

Trait Implementations§

Source§

impl Clone for FeatureState

Source§

fn clone(&self) -> FeatureState

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 FeatureState

Source§

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

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

impl<'de> Deserialize<'de> for FeatureState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&FeatureState> for NodeValueUpdate

Source§

fn from(s: &FeatureState) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for FeatureState

Source§

fn eq(&self, other: &FeatureState) -> 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 Serialize for FeatureState

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for FeatureState

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,