opcda-bridge 0.4.0

Reusable async Rust client library for the opcda-bridge gateway's gRPC API
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//! Reusable, presentation-free async client for the opcda-bridge gateway's
//! gRPC API.
//!
//! This crate is the typed connect/read/write/browse/search/list-servers surface
//! extracted from `opcda-bridge-client`'s `commands.rs`: no `clap`, no
//! `tabled`, no `serde_json`/`toml` — just [`Client`], the parameters its
//! methods take, and the plain result types they return ([`BrowsePage`],
//! [`SearchEvent`], [`SearchIndexResponse`], [`TagValue`], [`WriteResult`], [`Value`]). `opcda-bridge-client` depends
//! on this crate and adds only CLI parsing and table/JSON rendering on top
//! of it; any other async Rust program that needs typed OPC DA
//! reads/writes/browses without shelling out to the CLI binary and parsing
//! its output can depend on this crate directly instead.
//!
//! ```no_run
//! use opcda_bridge::{
//!     BrowsePageRequest, SearchIndexRequest, SearchMatchMode, SearchRequest,
//! };
//!
//! # async fn example() -> opcda_bridge::Result<()> {
//! let mut client = opcda_bridge::Client::connect("localhost:7600").await?;
//! let servers = client.list_servers().await?;
//! let root = client.browse(servers[0].clone(), 200).await?;
//! if let Some(token) = root.next_page_token.clone() {
//!     let request =
//!         BrowsePageRequest::next(servers[0].clone(), root.session_id.clone(), None, token, 200);
//!     let _next_page = client.browse_page(request).await?;
//! }
//! let mut search = client
//!     .search_stream(SearchRequest::new(
//!         servers[0].clone(),
//!         "Some",
//!         SearchMatchMode::Prefix,
//!     ))
//!     .await?;
//! while let Some(event) = search.message().await? {
//!     println!("{event:?}");
//! }
//! let indexed = client
//!     .search_index(SearchIndexRequest::new(
//!         servers[0].clone(),
//!         "Some PV",
//!         SearchMatchMode::Contains,
//!     ))
//!     .await?;
//! for found in indexed.matches {
//!     println!("{}: {}", found.display_name, found.item_id);
//! }
//! let values = client
//!     .read(servers[0].clone(), vec!["Some.Tag".into()])
//!     .await?;
//! client.close_browse_session(root.session_id).await?;
//! # let _ = values;
//! # Ok(())
//! # }
//! ```

mod client;
mod error;
mod types;

#[cfg(test)]
mod test_support;

pub use client::Client;
pub use client::SearchStream;
pub use error::{Error, Result};
pub use opcda_bridge_proto::DEFAULT_BRIDGE_PORT;
pub use types::{
    BrowseBreadcrumb, BrowseNode, BrowseNodeKind, BrowsePage, BrowsePageRequest, BrowseSource,
    Capabilities, DEFAULT_INDEX_SEARCH_MAX_RESULTS, DEFAULT_PAGE_SIZE, DEFAULT_SEARCH_MAX_RESULTS,
    IndexedSearchMatch, IndexedSearchProgress, NamespaceOrganization, SearchCompleted, SearchEvent,
    SearchIndexControlAction, SearchIndexRequest, SearchIndexResponse, SearchIndexState,
    SearchIndexStatus, SearchMatch, SearchMatchMode, SearchProgress, SearchRequest, TagValue,
    Value, WriteResult, parse_value,
};