zbus-lockstep-macros

-## [0.7.0] - 2026-07-27

Most notable and breaking change is the Result<T> type alias returns a concrete LockstepError instead of a rype erased, boxed object.
For the base retrieval functions this means users can now conveniently match on LockstepError variants to handle an error.

Also zbus-lockstep does a better job distinguishing between In and Out-ward arguments if users lookup the type of an argument by name.
Before, if In and Out arguments had the same name users would receive the signature for first argument encountered with that name, which might be the wrong one.

Lastly, the lookup functions have been sped up, for what it is worth.

🔒️ Security / Secrets

• 🔒️ ci: harden github actions security (d60dd9e)

🐛 Fixes

• 🐛 fix: Colliding args names distinguishable by direction (8306c5a)

📝 Documentation

• 📝 docs: update release instructions (9235c45)
• 📝 docs: fix intra-doc links (8da2335)
• 📝 docs: update CHANGELOG.md (c2b3166)

♻️ Refactor / Move files

• ♻️ refactor: Adjust resolve_xml_path to concrete erros (0d12452)
• ♻️ refactor!: Result alias contains concrete Error type (27d1a54)
• ♻️ refactor: Always return concrete LockstepError from functions. (2ca38af)
• ♻️ refactor!: Name arg_name argument equally across fns (ff05116)
• ♻️ refactor: Avoid allocations / double conversions (75eb77b)

💄 Art and Style

• 🎨 Clippy: Alphabetic order in imports (65ac228)

✅ Testing and validation

• ✅ test: Add tests to demonstrate equal name args bug (2d78faf)

Full Changelog: v0.6.0...v0.7.0

🐛 Fixes

• 🐛 fix: Colliding args names distinguishable by direction (8306c5a)

📝 Documentation

• 📝 docs: fix intra-doc links (8da2335)

♻️ Refactor / Move files

• ♻️ refactor: Adjust resolve_xml_path to concrete erros (0d12452)
• ♻️ refactor!: Result alias contains concrete Error type (27d1a54)
• ♻️ refactor: Always return concrete LockstepError from functions. (2ca38af)
• ♻️ refactor!: Name arg_name argument equally across fns (ff05116)
• ♻️ refactor: Avoid allocations / double conversions (75eb77b)

✅ Testing and validation

• ✅ test: Add tests to demonstrate equal name args bug (2d78faf)

What's Changed

• Improve README: show how crate is used as [dev-dependency].

• All macros, including [validate] try to do less when resolving xml path..

• Introduces macros feature which re-exports the validate proc-macro,
  allowing users to omit the zbus-lockstep-macros from dependencies.

• Upgrade to zbus-xml v5.2.0, fxing RUSTSEC-2026-0194

• Various small improvements.

Full Changelog: https://github.com/luukvanderduim/zbus-lockstep/commits/v0.6.0

This release documents how to use the crate as [dev-dependency]. The validate macro will return early when env variable LOCKSTEP_XML_PATH is found. Introduces macros feature which re-exports the validate proc-macro, allowing users to omit the zbus-lockstep-macros dependency.

✨ Features

• Feat (main)✨: Introduce macros feature (40a3aa9)

♻️ Refactor / Move files

• Refactor (main)♻️: No more panics inside resolve_xml_path (09e1e67)
• Refactor (macros) ➖: Do not depend on zbus-locstep (0cdebf6)

Build

• (⬆️) Keep dev-dependencies latest (955a5ce)

✅ Testing and validation

• Tests (macros) ✅: Raise doc ignore blocks to tests (9440a61)

chore: Release zbus-lockstep-macros version 0.5.2

chore: Clippy fixes (#8 Tait Hoyem)

chore: Release zbus-lockstep-macros version 0.5.1

feat: make [validate] attribute more flexible (#6) Tait Hoyem * Add support for any type - no longer restrict to structs.

build: Support bazel - (#5) by Nils Andre use CARGO_MANIFEST_DIR instead of current dir.

Update dependencies

• Move to zbus 5.0 (by TTWNO)

chore: Release zbus-lockstep-macros version 0.4.4

🧑‍💻 Improve DX

• 🧑‍💻 Also look in the directory with the crate name. This is useful if build is invoked from the workspace.

chore: Release zbus-lockstep-macros version 0.4.3

🐛 Fixes

• 🩹 validate now requires a comma separated argument list if multiple arguments are supplied.
• 🩹 In macros prefer relative paths to absolute paths.

📝 Documentation

• 📝 Mention resolve_xml_path can now find ..xml/ or ..XML/ too.

🧑‍💻 Improve DX

• 🧑‍💻 Be more lenient by adding parent to defaults for resolve_xml_path

🚸 Improve UX

• 🚸 Remove requirement zbus_xml to be in scope at macro call site.
• Add Copy, Clone, Hash, to public MshType.

📝 Documentation

• 📝 Update Readme to zbus-xml instead of zbus

✅ Testing and validation

• ✅ [lockstep] Remove unnecessary references.
• ✅ [macros] validate generated test now decorated with #[cfg(test)]

⚙️ Miscellaneous Tasks

• ➖ Swap zbus for zbus_xml

• ➖ Remove signatures_are_eq, assert_signatures_eq! and assert_signatures_ne!.

• ➖ Remove tests for signatures_are_eq, assert_signatures_eq! and assert_signatures_ne!.

⏪️ Revert / Remove

• 🔥 Cargo.lock
• ➖ Do not add changed Cargo.lock

✨ Features

• ✨ property_type_signature macro accepts identifying args.

property_type_signature!(member: "Frequency", interface: "org.noise.Kazoo")

• ✨ signal_body_type_signature macro accepts identifying args.

signal_body_type_signature!(member: "Telegram", interface: "org.mail.Man")

• ✨ method_args_signature macro accepts identifying args.

 method_args_signature!(member: "Frequency", interface: "org.noise.Kazoo")

• ✨ Add argument parameter to method_return_signature macro.
• ✨ Add argument parameter to method_args_signature macro.
• ✨ Add argument parameter to signal_body_type_signature macro.

🐛 Fixes

• 🐛 Cannot disambiguate between multiple 2-arg macro invocations

Remove second 2-arg macro invocations.

📝 Documentation

• 📝 property_type_signature macro doc examples.
• 📝 signal_body_type_signature macro doc examples.
• 📝 method_return_signature macro doc examples.
• 📝 Update docs to accompany added argument feature New examples to show how the macros may be called.

✅ Testing and validation

• ✅ Add property_type_signature macro identifier unit tests.
• ✅ Add signal_body_signature macro identifier unit tests.
• ✅ Add method_args_signature macro identifier unit tests.
• ✅ Add method_return_signature macro identifier unit tests.
• ✅ Add six unit tests to cover 'happy path' in macros.

🐛 Fixes

• 🐛 In macros with 'interface' arms, pass String instead of &str
• 🐛 'get_property_type' expects three args, not four.

✅ Testing and validation

• ✅ Add tests for macros with 'interface' arms.

🐛 Fixes

• 🩹 Fully qualify signatures_are_eq in macros.

🐛 Fixes

• 🩹 Fully qualify find_definition_in_dbus_xml! in macros.

✅ Testing and validation

• ✅ Ignore examples from test

• ✅ Adds tests for XML path retrieval macros:

• method_return_signature

• method_args_signature

• signal_body_type_signature

• property_type_signature

✨ Features

✨ Add signature retrieval macros for each msg-type

• resolve_xml_path function
• find_definition_in_dbus_xml Is used in macros:
• method_return_signature
• method_args_signature
• property_type_signature
• signal_body_type_signature

🐛 Fixes

• 🐛 Fix falsely identified previously found signal.
• Remove senseless checks.
• 🐛 [macros] Do not treat subdirectories as files.
• 🐛 Skip subdirectories in the xml-definitions path.
• 🐛 [macros] Cannot read contents from Cursor<str>, read from a File.
• 🐛 Canonicalize env and argument provided paths alike.
• 🐛 Fix: call the generated test after it is generated.
• 🩹 Replace hard coded directory paths with consts

📝 Documentation

• 📝 [macro] Improve README.md
• 📝 [macros] Improve validate macro documentation
• 📝 [macros] Document order of attribute macros
• • Remove mention of irrelevant Cache.xml
• 📝 Synchronize the three README's

♻️ Refactor / Move files

• ♻️ [macros] Remove function that resolves xml
• 🚚 Remove module marshall from public API

✅ Testing and validation

• ✅ [macros] CI test for path as argument
• ✅ [macros] Ads tests for RemoveNode with an xml-path as env-variable or as argument.
• ✅ Failing test in GH

⚙️ Miscellaneous Tasks

• Remove dependency on self in dev-dependencies