Skip to content

bridge: wire verbs

The verbs that describe the bridge itself rather than any file or service. The tables below are rendered from the same spec mzLibRust and mzLibR render; edit the spec, not this page. How the reference facts are generated explains the mechanism.

bridge_version

Report the bridge's version, its wire protocol, its .NET runtime, the mzLib it was built from, and every verb it dispatches.

Wire verb version · Python pymzlib.bridge_version

Wraps

Parameters

This verb takes no parameters.

Returns

Top-level fields:

Field Type Unit Null? Meaning
bridge string — never The bridge assembly's version. Not a compatibility number: use protocol.
protocol int — never The wire-format version; a binding is compatible with a bridge by this.
runtime string — never The bundled .NET runtime version.
mzlib string — yes: the build recorded no mzLib commit Which mzLib the bridge links, as 1.0.0+, read from the linked assembly.
verbs string[] — never Every verb this bridge dispatches, in dispatch order, GENERATED at build time from the DispatchAsync switch (BULK.md section 5). Absent from bridges before pyMzLib 0.2.0 (optional forever). A binding calling a verb its bridge does not list raises its usage error naming the release that has it, from that verb's since, instead of spawning a process.

Errors

Kind pyMzLib raises When
service_unavailable ServiceUnavailableError never raised by this verb

Caveats

  • verbs lists what the bridge ROUTES, not which options each verb takes: a bulk option (--paths-stdin) on an older bridge that lists the verb still fails with that bridge's usage error.
  • Bridges built before verbs existed omit the key; a binding must treat its absence as 'lists nothing', which correctly refuses every verb added since.

Example

info = pymzlib.bridge_version()

Recorded from the live bridge as bridge_version.json. The doctests in the API reference replay these recordings in CI.

Same verb in other bindings

Python (pyMzLib) Rust (mzLibRust) R (mzLibR)
pymzlib.bridge_version mzlib::bridge_version mzlibr_bridge_version

References

None: no publication is attached to this verb.

Since

Wire protocol pyMzLib mzLibRust mzLibR
1 0.1.0 0.1.0 0.1.0

Not yet verified

  • The Unknown-command message and verbs share one generated list (Program.Verbs, from the DeriveVerbList MSBuild task); check_verbs.py still parses the switch itself. Both read the same pattern, so they cannot disagree unless the switch stops being one arm per line.
  • pyMzLib returns version as a plain dict, typed as the TypedDict pymzlib.BridgeVersion so its keys are documented and linted; Rust returns the struct mzlib::BridgeVersion, R a named list.