Crate zbus_lockstep

Source
Expand description

§zbus-lockstep

Is a collection of helpers for retrieving DBus type signatures from XML descriptions. Useful for comparing these with your types’ signatures to ensure that they are compatible.

It offers functions that retrieve the signature of a method’s argument type, of a method’s return type, pf a signal’s body type or of a property’s type from DBus XML.

These functions require that you provide the file path to the XML file, the interface name, and the interface member wherein the signature resides.

Corresponding to each of these functions, macros are provided which do not require you to exactly point out where the signature is found. These will just search by interface member name.

The macros assume that the file path to the XML files is either:

  • xml or XML, the default path for DBus XML files - or is set by the
  • LOCKSTEP_XML_PATH, the env variable that overrides the default.

Re-exports§

pub use zbus_xml;
pub use zbus_xml::ArgDirection::In;
pub use zbus_xml::ArgDirection::Out;

Macros§

method_args_signature
Retrieve the signature of a method’s arguments.
method_return_signature
Retrieve the signature of a method’s return type.
property_type_signature
Retrieve the signature of a property’s type.
signal_body_type_signature
Retrieve the signature of a signal’s body type.

Structs§

Node
An introspection tree node (typically the root of the XML document).

Enums§

LockstepError
MsgType

Functions§

get_method_args_type
Retrieve the signature of a method’s argument type from XML.
get_method_return_type
Retrieve the signature of a method’s return type from XML.
get_property_type
Retrieve the signature of a property’s type from XML.
get_signal_body_type
Retrieve a signal’s body type signature from DBus XML.
resolve_xml_path
Resolve XML path from either: