bytehound-opc-da-client 0.2.3

Backend-agnostic OPC DA client library for Rust — async, trait-based, with transparent COM management
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

use crate::opc_da::errors::{OpcError, OpcResult};

/// Public group state management functionality.
///
/// Provides methods to manage public groups in OPC servers. Public groups
/// can be shared between multiple clients, allowing for more efficient
/// server resource usage.
pub trait PublicGroupStateMgtTrait {
    fn interface(&self) -> OpcResult<&crate::bindings::da::IOPCPublicGroupStateMgt>;

    /// Gets the public state of the group.
    ///
    /// # Returns
    /// `true` if the group is public, `false` if it is private
    fn get_state(&self) -> OpcResult<bool> {
        // SAFETY: Calling COM interface method GetState.
        unsafe { Ok(self.interface()?.GetState()?.as_bool()) }
    }

    /// Converts a private group to a public group.
    ///
    /// # Returns
    /// Ok(()) if the group was successfully converted to public
    ///
    /// # Notes
    /// Once a group becomes public, it remains public until the server
    /// is shut down or the group is deleted.
    fn move_to_public(&self) -> OpcResult<()> {
        // SAFETY: Calling COM interface method MoveToPublic.
        unsafe { Ok(self.interface()?.MoveToPublic()?) }
    }
}