Struct term_transcript::svg::TemplateOptions

pub struct TemplateOptions {
    pub width: usize,
    pub palette: Palette,
    pub font_family: String,
    pub window_frame: bool,
    pub scroll: Option<ScrollOptions>,
    pub wrap: Option<WrapOptions>,
    pub line_numbers: Option<LineNumbers>,
}

Available on crate feature svg only.

Configurable options of a Template.

Fields

width: usize

Width of the rendered terminal window in pixels. The default value is 720.

palette: Palette

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

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.

Implementations

impl TemplateOptions

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 Clone for TemplateOptions

fn clone(&self) -> TemplateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

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.