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

StepOutcome.refusal

Why tmux refused this invocation, in the crate's error vocabulary.

Source and package
Qualified name
libtmux::plan::run::StepOutcome::refusal
Module
plan.run
Declared in
StepOutcome
Package
libtmux
Source
crates/libtmux/src/plan/run.rs
#[must_use] pub fn refusal(&self) -> Option<Error>

Description#

A refusal is data rather than an error here, because a plan may expect one. Without sensitive input, this classifies it the same way a direct call would, so a caller can match on Error::SessionExists rather than racing another session creation. A sensitive invocation reports Error::CommandFailed and withholds tmux output.

None when the invocation succeeded.

Esc

Type to search.

Reference previewOpen reference