Struct term_transcript::svg::TemplateOptions

source · [−]

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>,
}

Available on crate feature svg only.

Expand description

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.

Trait Implementations

impl Clone for TemplateOptions

fn clone(&self) -> TemplateOptions

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for TemplateOptions

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

Formats the value using the given formatter. Read more

impl Default for TemplateOptions

fn default() -> Self

Returns the “default value” for a type. Read more

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. Read more

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. Read more

Auto Trait Implementations

impl RefUnwindSafe for TemplateOptions

impl Send for TemplateOptions

impl Sync for TemplateOptions

impl Unpin for TemplateOptions

impl UnwindSafe for TemplateOptions

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,