Skip to main content

CliOutput

Struct CliOutput 

Source
pub struct CliOutput<T: Serialize> {
    pub success: bool,
    pub data: Option<T>,
    pub error: Option<CliError>,
    pub pagination: Option<PaginationMeta>,
    pub platform: String,
    pub command: String,
}
Expand description

Unified CLI JSON output envelope.

On success, data is populated and error is None. On failure, error is populated and data is None. Fields with None values are omitted from serialized output.

Fields§

§success: bool

Whether the command succeeded.

§data: Option<T>

The payload data, present only on success.

§error: Option<CliError>

Error details, present only on failure.

§pagination: Option<PaginationMeta>

分页元数据,仅列表类命令出现。

非列表命令不序列化此字段,因此其输出与本特性引入前逐字节相同。

§platform: String

The detected platform (e.g. "github").

§command: String

The command that was executed (e.g. "issue create").

Implementations§

Source§

impl<T: Serialize> CliOutput<T>

Source

pub fn success(data: T, platform: &str, command: &str) -> Self

Create a successful output with the given data.

Source

pub fn failure(error: CliError, platform: &str) -> Self

Create a failed output with the given error.

Source

pub fn success_paged( data: T, pagination: PaginationMeta, platform: &str, command: &str, ) -> Self

创建带分页元数据的成功输出。

Trait Implementations§

Source§

impl<T: Clone + Serialize> Clone for CliOutput<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Serialize> Debug for CliOutput<T>

Source§

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

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

impl<T> Serialize for CliOutput<T>
where T: Serialize + Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<T> Freeze for CliOutput<T>
where Option<T>: Freeze,

§

impl<T> RefUnwindSafe for CliOutput<T>

§

impl<T> Send for CliOutput<T>
where Option<T>: Send,

§

impl<T> Sync for CliOutput<T>
where Option<T>: Sync,

§

impl<T> Unpin for CliOutput<T>
where Option<T>: Unpin,

§

impl<T> UnsafeUnpin for CliOutput<T>
where Option<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for CliOutput<T>
where Option<T>: UnwindSafe,

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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