Struct codevis::render::Options

pub struct Options<'a> {

    pub column_width: u32,
    pub line_height: u32,
    pub readable: bool,
    pub show_filenames: bool,
    pub target_aspect_ratio: f64,
    pub threads: usize,
    pub highlight_truncated_lines: bool,
    pub fg_color: FgColor,
    pub bg_color: BgColor,
    pub theme: &'a str,
    pub force_full_columns: bool,
    pub ignore_files_without_syntax: bool,
    pub plain: bool,
    pub display_to_be_processed_file: bool,
    pub color_modulation: f32,
    pub tab_spaces: u32,
    pub line_nums: bool,
}

Configure how to render an image.

Fields

column_width: u32

How many characters wide each column is.

line_height: u32

How many pixels high each line is.

readable: bool

Whether to render the image in a readable way.

show_filenames: bool

Whether or not to write the file path and name at the top of each file.

target_aspect_ratio: f64

threads: usize

The number of threads to use for rendering.

highlight_truncated_lines: bool

fg_color: FgColor

bg_color: BgColor

theme: &'a str

The color theme to use.

force_full_columns: bool

Sacrifice aspect ratio to fill the image with full columns.

ignore_files_without_syntax: bool

Whether to ignore files without syntactic highlighting.

plain: bool

display_to_be_processed_file: bool

color_modulation: f32

tab_spaces: u32

The number of spaces to use for a tab character.

line_nums: bool

Trait Implementations

impl<'a> Clone for Options<'a>

fn clone(&self) -> Options<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Options<'a>

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

Formats the value using the given formatter.

impl Default for Options<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Copy for Options<'a>