Struct RenderSettings 

pub struct RenderSettings { /* private fields */ }

The output features selected for one render operation.

The default is deliberately dumb: no escape-sequence-producing feature is selected. A terminal’s detected maximum can be adopted with From and then narrowed with the named setters.

Implementations

impl RenderSettings

pub const fn all() -> Self

Selects every rendering feature without degrading logical styles.

This is intended for serializers whose styles have already been narrowed to the output’s capabilities. Ordinary terminal output should detect capabilities and convert them with From.

pub const fn get_color_level(self) -> ColorLevel

pub const fn get_attributes(self) -> TextAttributes

pub const fn get_underline_styles(self) -> UnderlineStyleSet

pub const fn get_underline_colors(self) -> bool

pub const fn get_hyperlinks(self) -> bool

pub const fn color_level(self, color_level: ColorLevel) -> Self

pub const fn attributes(self, attributes: TextAttributes) -> Self

pub const fn underline_styles(self, styles: UnderlineStyleSet) -> Self

pub const fn underline_colors(self, enabled: bool) -> Self

pub const fn hyperlinks(self, enabled: bool) -> Self

pub const fn reset_color_level(self) -> Self

pub const fn reset_attributes(self) -> Self

pub const fn reset_underline_styles(self) -> Self

pub const fn reset_underline_colors(self) -> Self

pub const fn reset_hyperlinks(self) -> Self

pub fn resolve_text_style(self, style: &TextStyle) -> TextStyle

Applies these selected features to one logical text style.

This is useful to output backends that serialize runs themselves, such as an interactive prompt renderer. Ordinary static output should call render for the whole resolved view.

Trait Implementations

impl Clone for RenderSettings

fn clone(&self) -> RenderSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderSettings

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

Formats the value using the given formatter.

impl Default for RenderSettings

fn default() -> RenderSettings

Returns the “default value” for a type.

impl From<TerminalCapabilities> for RenderSettings

fn from(capabilities: TerminalCapabilities) -> Self

Converts to this type from the input type.

impl PartialEq for RenderSettings

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for RenderSettings

impl Eq for RenderSettings

impl StructuralPartialEq for RenderSettings