Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error {
Show 17 variants ExecutableNotFound { executable: PathBuf, }, Io { operation: &'static str, source: Error, }, Timeout { summary: CommandSummary, timeout: Duration, }, CommandFailed { operation: &'static str, result: Box<CommandResult>, }, ServerUnavailable { message: String, }, ObjectNotFound { kind: ObjectKind, target: String, }, MultipleObjects { kind: ObjectKind, count: usize, query: String, }, InvalidId { kind: &'static str, value: String, }, InvalidSessionName(String), InvalidArgument { argument: &'static str, message: String, }, InvalidVersion(String), Unsupported { capability: &'static str, required: ReleaseVersion, found: TmuxVersion, }, Decode { context: &'static str, message: String, }, Option { kind: OptionErrorKind, message: String, }, NotInsideTmux, WaitTimeout { condition: String, }, Cleanup { operation: &'static str, source: Box<Error>, },
}
Expand description

A non-exhaustive error produced by configuration, execution, or parsing.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

ExecutableNotFound

The configured tmux executable was not found.

Fields

§executable: PathBuf

The configured executable path.

§

Io

A process or file operation failed.

Fields

§operation: &'static str

A static operation name.

§source: Error

The underlying operating-system error.

§

Timeout

A command exceeded the configured timeout.

Fields

§summary: CommandSummary

The redacted command description.

§timeout: Duration

The configured timeout.

§

CommandFailed

tmux returned a non-zero status for a typed operation.

Fields

§operation: &'static str

The attempted high-level operation.

§result: Box<CommandResult>

The complete byte-preserving result.

§

ServerUnavailable

No tmux server was available on the requested socket.

Fields

§message: String

Diagnostic text returned by tmux.

§

ObjectNotFound

A requested tmux object did not exist.

Fields

§kind: ObjectKind

The expected object kind.

§target: String

The target used for lookup.

§

MultipleObjects

A lookup that expected one object returned multiple objects.

Fields

§kind: ObjectKind

The object kind.

§count: usize

The number of matches.

§query: String

A redacted query description.

§

InvalidId

An ID did not use the required prefix and numeric suffix.

Fields

§kind: &'static str

The ID kind.

§value: String

The invalid representation.

§

InvalidSessionName(String)

A session name used tmux-reserved target punctuation.

§

InvalidArgument

A public argument did not satisfy its contract.

Fields

§argument: &'static str

The argument name.

§message: String

The validation failure.

§

InvalidVersion(String)

tmux returned an unrecognized version.

§

Unsupported

The connected tmux version lacks a requested capability.

Fields

§capability: &'static str

The requested operation or field.

§required: ReleaseVersion

The minimum release.

§found: TmuxVersion

The actual connected version.

§

Decode

Structured tmux output could not be decoded.

Fields

§context: &'static str

The output family being decoded.

§message: String

A safe explanation without untrusted output interpolation.

§

Option

An option value or index was invalid.

Fields

§kind: OptionErrorKind

The failure category.

§message: String

The failure description.

§

NotInsideTmux

An operation required being inside an attached tmux client.

§

WaitTimeout

A wait condition expired before it was satisfied.

Fields

§condition: String

A description of the condition.

§

Cleanup

The main operation succeeded but deterministic cleanup failed.

Fields

§operation: &'static str

The operation whose scope was being cleaned up.

§source: Box<Error>

The cleanup error.

Trait Implementations§

Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Freeze for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more