Struct ErrorContract

Source

pub struct ErrorContract {
    pub kind: &'static str,
    pub exit_code: i32,
    pub retryable: bool,
    pub description: &'static str,
}

Expand description

One failure mode of the CLI, in the form an agent consumes it.

This table is the single source of truth for the error contract: jira schema renders it, the stderr envelope emits one of its kind values, and the process exits with its exit_code. Declaring a kind here that no ApiError can produce would promise agents a branch that never runs, so every entry is pinned to a reachable variant by every_declared_error_kind_is_reachable.

Fields§

§kind: &'static str§exit_code: i32§retryable: bool

Whether retrying the identical command can plausibly succeed.

§description: &'static str

Auto Trait Implementations§

§

ErrorContract

Struct ErrorContract Copy item path

Fields§

Auto Trait Implementations§

impl Freeze for ErrorContract

impl RefUnwindSafe for ErrorContract

impl Send for ErrorContract

impl Sync for ErrorContract

impl Unpin for ErrorContract

impl UnsafeUnpin for ErrorContract

impl UnwindSafe for ErrorContract

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

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

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

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

fn bold(&self) -> BoldDisplay<'_, Self>

fn dimmed(&self) -> DimDisplay<'_, Self>

fn italic(&self) -> ItalicDisplay<'_, Self>

fn underline(&self) -> UnderlineDisplay<'_, Self>

fn blink(&self) -> BlinkDisplay<'_, Self>

fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>

fn reversed(&self) -> ReversedDisplay<'_, Self>

fn hidden(&self) -> HiddenDisplay<'_, Self>

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Struct ErrorContract

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

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

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

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

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

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

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

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