Skip to main content

OutputRenderer

Struct OutputRenderer 

Source
pub struct OutputRenderer { /* private fields */ }

Implementations§

Source§

impl OutputRenderer

Source

pub fn new(format: OutputFormat) -> Self

Source

pub fn with_envelope(self, envelope: bool) -> Self

Source

pub fn format(&self) -> OutputFormat

Source

pub fn render<T: Serialize>(&self, value: &T) -> Result<()>

Source

pub fn render_list<T: Serialize>(&self, items: &[T]) -> Result<()>

Render a list/array of items. When –envelope is enabled and format is JSON/YAML, wraps output in {"data": [...], "count": N}. Otherwise renders as normal.

Source

pub fn render_list_or_empty<T: Serialize>( &self, items: &[T], empty_message: &str, ) -> Result<()>

Render a list, with a human-readable note when it is empty.

Table and Markdown are read by people, so they get the message. Every machine format gets an empty array instead, because a script doing | jq cannot parse prose. Printing “No pull requests found” under --format json is what #110 reported, across ~70 list commands.

Source

pub fn render_raw(&self, content: &str) -> Result<()>

Render pre-formatted content directly to stdout (e.g. for markdown issue views).

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> 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, 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.