Struct below_render::RenderConfig

pub struct RenderConfig {
    pub title: Option<String>,
    pub format: Option<RenderFormat>,
    pub indented_prefix: Option<String>,
    pub suffix: Option<String>,
    pub fold: Option<FoldOption>,
    pub width: Option<usize>,
}

Config object for specifying how to render a Field. Options are ordered roughly by their order of processing.

Fields

title: Option<String>

format: Option<RenderFormat>

Converting Field to String.

indented_prefix: Option<String>

Prefix when rendered with indent. Each extra level adds same number of spaces equal to the length of this prefix. This allows us to render: -+ branch -* leaf -* another_leaf The example above use two prefixes, “-+ “ and “-* “. Root has no prefix.

suffix: Option<String>

fold: Option<FoldOption>

Fit a long rendered Field into smaller width by omitting some characters in the middle instead of truncating. Only applies when rendering Field with fixed width. Taken indent, prefix and suffix len into account.

width: Option<usize>

For fixed width rendering. Truncate or pad whitespace to output.

Implementations

impl RenderConfig

pub fn update<T: Into<Self>>(self, overrides: T) -> Self

pub fn get_title(&self) -> &str

pub fn render_title(&self, fixed_width: bool) -> String

pub fn render_indented(
    &self,
    field: Option<Field>,
    fixed_width: bool,
    depth: usize
) -> String

Renders Field with all options applied. depth specifies the depth of the model of this Field, where the model is Recursive, i.e. it works as a node in a tree. Currently this only affects indented_prefix.

pub fn render(&self, field: Option<Field>, fixed_width: bool) -> String

Renders Field with all options without indent.

Trait Implementations

impl Clone for RenderConfig

fn clone(&self) -> RenderConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RenderConfig

fn default() -> RenderConfig

Returns the “default value” for a type.

impl From<RenderConfig> for RenderConfigBuilder

fn from(rc: RenderConfig) -> Self

Performs the conversion.

impl From<RenderConfigBuilder> for RenderConfig

fn from(b: RenderConfigBuilder) -> Self

Performs the conversion.