Skip to main content

FailureKind

Enum FailureKind 

Source
pub enum FailureKind {
    MissingHome,
    UnsupportedShell,
    InvalidTargetPath,
    DefaultPathUnavailable,
    CompletionTargetUnavailable,
    CompletionFileUnreadable,
    ProfileUnavailable,
    ProfileCorrupted,
}
Expand description

Stable failure kinds for recoverable operational errors.

crate::Error::Failure wraps a FailureReport carrying one of these kinds so callers can branch on failure categories without parsing human-readable text.

Variants§

§

MissingHome

HOME was not available and no fallback path could be derived.

§

UnsupportedShell

The requested shell is not implemented.

§

InvalidTargetPath

The requested target path was invalid.

This typically means a provided path_override did not include a usable parent directory.

§

DefaultPathUnavailable

The default managed install path could not be resolved.

§

CompletionTargetUnavailable

The completion file or its directory could not be created or written.

§

CompletionFileUnreadable

The completion file existed but could not be read as expected.

§

ProfileUnavailable

The managed shell profile could not be written or removed.

§

ProfileCorrupted

The managed shell profile was present but malformed.

This usually means a previously managed block has a missing end marker or otherwise cannot be updated safely.

Implementations§

Source§

impl FailureKind

Source

pub const fn code(self) -> &'static str

Returns a stable machine-readable code for monitoring and telemetry.

Source

pub const fn is_retryable(self) -> bool

Returns whether the kind is generally worth a retry with corrected environment or timing.

Trait Implementations§

Source§

impl Clone for FailureKind

Source§

fn clone(&self) -> FailureKind

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FailureKind

Source§

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

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

impl PartialEq for FailureKind

Source§

fn eq(&self, other: &FailureKind) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for FailureKind

Source§

impl Eq for FailureKind

Source§

impl StructuralPartialEq for FailureKind

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.