Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-rs latest

Planner.explain

Group a plan and say why each invocation is separate.

Source and package
Qualified name
libtmux::plan::planner::Planner::explain
Module
plan.planner
Declared in
Planner
Package
libtmux
Source
crates/libtmux/src/plan/planner.rs
#[must_use] pub fn explain(&self, plan: &Plan) -> Vec< (Step, StepReason) >

Examples#

use libtmux::plan::{CapturePane, Plan, Planner, StepReason};
use libtmux::PaneId;
let pane: PaneId = "%1".parse()?;
let mut plan = Plan::new();
plan.add(CapturePane::new(pane));
let explained = Planner::Folding.explain(&plan);
assert_eq!(explained[0].1, StepReason::ReadsOutput);
Parameters
Esc

Type to search.

Reference previewOpen reference