Struct ToolDriver 

pub struct ToolDriver { /* private fields */ }

The driver that runs the repository’s own majordomus capture session.

It finds the tool the way a provider hook’s shim does and in the same order — the repository’s bin/majordomus, an installation under .majordomus/, then whatever is on the path — because a second resolution order would be a second answer to “which tool is this repository’s”, and the shims are the ones that have been right about it for months.

When no tool is found it records nothing and says why, in the episode’s own field:

use majordomus_cli::episodes::{EpisodeDriver, ToolDriver};
let empty = std::env::temp_dir().join("mj-tooldriver-doctest-no-tool");
std::env::remove_var("PATH"); // nor any majordomus on the path
let said = ToolDriver::new(&empty).open("generic", "t1");
assert!(said.starts_with("no episode was recorded"), "{said}");

Implementations

impl ToolDriver

pub fn new(root: impl Into<PathBuf>) -> Self

A driver for the repository at root. Nothing is resolved or run here: the tool is looked for on every event, so a bin/majordomus built after the server started is the one used.

use majordomus_cli::episodes::ToolDriver;
let driver = ToolDriver::new("/srv/repo");
assert!(format!("{driver:?}").contains("/srv/repo"));

Trait Implementations

impl Clone for ToolDriver

fn clone(&self) -> ToolDriver

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolDriver

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

Formats the value using the given formatter.

impl EpisodeDriver for ToolDriver

fn open(&self, provider: &str, external_id: &str) -> String

Open the episode for external_id under provider. Returns what to record in ConnectionEpisode::repository — a description of what happened, successful or not. It is called once per episode, on the first attach; a resume does not call it again.

fn close( &self, provider: &str, external_id: &str, reason: CloseReason, ) -> String

Close it, with the reason the record is to carry. Returns what the repository did, which replaces the episode’s repository field on the way out.