Crate zenoh_flow_commons

This crate centralises structures that are shared across Zenoh-Flow.

⚠️ This crate is intended for internal usage within Zenoh-Flow. All structures that are exposed in public facing API are re-exposed in the relevant crates.

Structs

Configuration

A Configuration is a recursive key-value structure that allows modifying the behaviour of a node without altering its implementation.

InstanceId

An InstanceId uniquely identifies a data flow instance.

NodeId

A NodeId uniquely identifies a Node within a data flow.

PortId

A PortId identifies an Input or an Output of a Node.

RuntimeId

A RuntimeId uniquely identifies a Zenoh-Flow runtime within a Zenoh network.

SharedMemoryConfiguration

Structure to configure how Zenoh-Flow uses the shared memory feature provided by Zenoh.

Vars

Vars is an internal structure that we use to expand the “moustache variables” in a descriptor file.

Traits

IMergeOverwrite

Types which can be combined with another instance of the same type and for which, in case there are common elements, the elements of self would be kept over those held by other.

Functions

deserialize_id

Deserialise, from a String, an Arc<str> that is guaranteed to be a valid Zenoh-Flow NodeId or PortId.

parse_vars

Parse a single Var from a string of the format “KEY=VALUE”.

try_parse_from_file

Attempts to parse an instance of N from the content of the file located at path, overwriting (or complementing) the Vars declared in said file with the provided vars.

Type Aliases

Result

Zenoh-Flow’s result type.