Struct TemplateOptions 

pub struct TemplateOptions {
    pub width: usize,
    pub line_height: Option<f64>,
    pub advance_width: Option<f64>,
    pub palette: Palette,
    pub additional_styles: String,
    pub font_family: String,
    pub window_frame: bool,
    pub scroll: Option<ScrollOptions>,
    pub wrap: Option<WrapOptions>,
    pub line_numbers: Option<LineNumbers>,
    pub font_embedder: Option<Box<dyn FontEmbedder<Error = Box<dyn Error + Send + Sync>>>>,
}

Available on crate feature svg only.

Configurable options of a Template.

Serialization

Options can be deserialized from serde-supported encoding formats, such as TOML. This is used in the CLI app to read options from a file:

let options_toml = r#"
width = 900
window_frame = true
line_numbers = 'continuous'
wrap.hard_break_at = 100
scroll = { max_height = 300, pixels_per_scroll = 18, interval = 1.5 }

[palette.colors]
black = '#3c3836'
red = '#b85651'
green = '#8f9a52'
yellow = '#c18f41'
blue = '#68948a'
magenta = '#ab6c7d'
cyan = '#72966c'
white = '#a89984'

[palette.intense_colors]
black = '#5a524c'
red = '#b85651'
green = '#a9b665'
yellow = '#d8a657'
blue = '#7daea3'
magenta = '#d3869b'
cyan = '#89b482'
white = '#ddc7a1'
"#;

let options: TemplateOptions = toml::from_str(options_toml)?;
assert_eq!(options.width, 900);
assert_matches!(options.wrap, Some(WrapOptions::HardBreakAt(100)));
assert_eq!(
    options.palette.colors.green,
    RgbColor(0x8f, 0x9a, 0x52)
);

Fields

width: usize

Width of the rendered terminal window in pixels. Excludes the line numbers width if line numbering is enabled. The default value is 720.

line_height: Option<f64>

Line height relative to the font size. If not specified, will be taken from font metrics (if a font is embedded), or set to 1.2 otherwise.

advance_width: Option<f64>

Advance width of a font relative to the font size (i.e., in em units). If not specified, will be taken from font metrics (if a font is embedded), or set to 8px (~0.57em) otherwise.

For now, advance width is only applied to the pure SVG template.

palette: Palette

Palette of terminal colors. The default value of Palette is used by default.

additional_styles: String

CSS instructions to add at the beginning of the SVG <style> tag. This is mostly useful to import fonts in conjunction with font_family.

The value is not validated in any way, so supplying invalid CSS instructions can lead to broken SVG rendering.

font_family: String

Font family specification in the CSS format. Should be monospace.

window_frame: bool

Indicates whether to display a window frame around the shell. Default value is false.

scroll: Option<ScrollOptions>

Options for the scroll animation. If set to None (which is the default), no scrolling will be enabled, and the height of the generated image is not limited.

wrap: Option<WrapOptions>

Text wrapping options. The default value of WrapOptions is used by default.

line_numbers: Option<LineNumbers>

Line numbering options.

font_embedder: Option<Box<dyn FontEmbedder<Error = Box<dyn Error + Send + Sync>>>>

Font embedder that will embed the font into the SVG file via @font-face CSS. This guarantees that the SVG will look identical on all platforms.

Implementations

impl TemplateOptions

pub fn with_font_embedder(self, embedder: impl FontEmbedder) -> Self

Sets the font embedder to be used.

pub fn with_font_subsetting(self, options: FontSubsetter) -> Self

Available on crate feature font-subset only.

Sets the standard font embedder / subsetter.

pub fn render_data<'s>( &'s self, transcript: &'s Transcript, ) -> Result<HandlebarsData<'s>, TermError>

Generates data for rendering.

Errors

Returns an error if output cannot be rendered to HTML (e.g., it contains invalid SGR sequences).

Trait Implementations

impl Debug for TemplateOptions

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

Formats the value using the given formatter.

impl Default for TemplateOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TemplateOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TemplateOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.