Skip to main content

Renderer

Struct Renderer 

Source
pub struct Renderer { /* private fields */ }
Expand description

Terminal renderer for Wikipedia content.

Renders to any Write target — use Renderer::stdout for normal display, or [Renderer::to_buf] to capture ANSI-colored output into a Vec<u8> (e.g. for piping into a pager).

§Example

use wiky::{Config, Renderer};

let config  = Config::default();
let theme   = config.active_theme();
let renderer = Renderer::stdout(theme, 100, true);
renderer.print_message("Hello, wiky! ✨");

Implementations§

Source§

impl Renderer

Source

pub fn stdout(theme: Theme, width: u16, emoji: bool) -> Self

Create a renderer that writes to stdout.

Source

pub fn new(theme: Theme, width: u16, emoji: bool) -> Self

Backwards-compatible constructor alias.

Source

pub fn article_to_string(&self, article: &Article) -> String

Render a full article into a colored String.

Source

pub fn search_to_string(&self, query: &str, results: &[SearchResult]) -> String

Render search results into a colored String.

Source

pub fn summary_to_string(&self, article: &Article) -> String

Render a summary into a colored String.

Source

pub fn render_article(&self, article: &Article)

Render a full Article to stdout.

Source

pub fn render_summary(&self, article: &Article)

Render only the summary of an article to stdout.

Source

pub fn render_search_results(&self, query: &str, results: &[SearchResult])

Render a list of search results to stdout.

Source

pub fn print_message(&self, msg: &str)

Print a plain message to stdout.

Source

pub fn dim_str(&self, s: &str) -> String

Return a dim-colored string (useful for callers that do their own printing).

Source

pub fn print_success(&self, msg: &str)

Print a success message to stdout.

Source

pub fn print_error(&self, msg: &str)

Print an error message to stderr.

Source

pub fn render_config_info(&self, config: &Config)

Render current config settings to stdout.

Source

pub fn render_themes_list(&self)

Render the list of available themes to stdout.

Source

pub fn render_disambiguation(&self, article: &Article, opts: &[DisambigOption])

Render a disambiguation page options to stdout as a numbered list.

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> 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> PolicyExt for T
where T: ?Sized,

Source§

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

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

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

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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.
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