Enum OpcCommand 

pub enum OpcCommand {
    Servers {
        bridge_host: Option<String>,
    },
    Read {
        bridge_host: Option<String>,
        server: Option<String>,
        tags: Vec<String>,
    },
    Write {
        bridge_host: Option<String>,
        server: Option<String>,
        tag: String,
        value: String,
    },
    Browse {
        bridge_host: Option<String>,
        server: Option<String>,
        session_id: Option<String>,
        parent_node_key: Option<String>,
        page_token: Option<String>,
        page_size: u32,
        all: bool,
        refresh: bool,
    },
    Close {
        bridge_host: Option<String>,
        session_id: String,
    },
    Search {
        bridge_host: Option<String>,
        server: Option<String>,
        query: String,
        match_mode: OpcSearchMatchModeArg,
        max_results: u32,
        session_id: Option<String>,
        scope_node_key: Option<String>,
        include_branches: bool,
        refresh: bool,
    },
    SearchIndex {
        command: SearchIndexCommand,
    },
}

Variants

Servers

List the OPC DA servers registered on the bridge gateway’s host.

Fields

bridge_host: Option<String>

(default: crate::config::DEFAULT_BRIDGE_HOST, overridable via BHTUNE_BRIDGE_HOST or the config file’s bridge_host key.)

Read

Read one or more tags.

Fields

bridge_host: Option<String>

(default: crate::config::DEFAULT_BRIDGE_HOST, overridable via BHTUNE_BRIDGE_HOST or the config file’s bridge_host key.)

server: Option<String>

(default: the config file’s server key; errors if neither is set.)

tags: Vec<String>

Write

Write a value to one tag.

Fields

bridge_host: Option<String>

server: Option<String>

tag: String

value: String

Browse

Browse one bounded page of tags. Without a session, lists the root level.

Fields

bridge_host: Option<String>

server: Option<String>

session_id: Option<String>

Existing bridge browse session to continue or use with parent-node-key.

parent_node_key: Option<String>

Opaque node key returned by a previous page.

page_token: Option<String>

Opaque continuation token returned by a previous page.

page_size: u32

Number of immediate children to request.

all: bool

Follow continuation pages until the requested level is complete.

refresh: bool

Ask the gateway to refresh its namespace view.

Close

Explicitly release a gateway browse session returned by opc browse.

Fields

bridge_host: Option<String>

session_id: String

Opaque browse-session ID returned by opc browse.

Search

Search the OPC DA namespace without downloading the whole tree.

Fields

bridge_host: Option<String>

server: Option<String>

query: String

Text to find in node labels/item IDs.

match_mode: OpcSearchMatchModeArg

How the query should match.

max_results: u32

Maximum number of matches.

session_id: Option<String>

Existing bridge browse session to search within.

scope_node_key: Option<String>

Opaque node key limiting the search scope.

include_branches: bool

Include branch nodes as search results.

refresh: bool

Ask the gateway to refresh its namespace view.

SearchIndex

Query and manage the gateway’s persistent namespace search index.

Fields

command: SearchIndexCommand

Trait Implementations

impl Debug for OpcCommand

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

Formats the value using the given formatter.

impl FromArgMatches for OpcCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for OpcCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand