Skip to main content

ExportSvgOptions

Struct ExportSvgOptions 

Source
pub struct ExportSvgOptions<'a> {
    pub title: &'a str,
    pub theme: Option<&'a TerminalTheme>,
    pub clear: bool,
    pub code_format: Option<&'a str>,
    pub font_aspect_ratio: f64,
    pub unique_id: &'a str,
}
Expand description

The keyword arguments of upstream’s Console.export_svg and save_svg, for Console::export_svg_recorded.

Fields§

§title: &'a str

title=: the window title (default "Rich").

§theme: Option<&'a TerminalTheme>

theme=: the palette, or None for SVG_EXPORT_THEME.

§clear: bool

clear=: empty the record afterwards (default true).

§code_format: Option<&'a str>

code_format=: the image template, or None for CONSOLE_SVG_FORMAT.

§font_aspect_ratio: f64

font_aspect_ratio=: the font’s width to height (default 0.61).

§unique_id: &'a str

unique_id=: the prefix of the image’s ids and classes. Upstream’s default hashes Python’s repr() of the segments, which Rust cannot reproduce (DIVERGENCES §15); the default here is "terminal".

Trait Implementations§

Source§

impl<'a> Clone for ExportSvgOptions<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for ExportSvgOptions<'a>

Source§

impl Default for ExportSvgOptions<'_>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<'a> Freeze for ExportSvgOptions<'a>

§

impl<'a> RefUnwindSafe for ExportSvgOptions<'a>

§

impl<'a> Send for ExportSvgOptions<'a>

§

impl<'a> Sync for ExportSvgOptions<'a>

§

impl<'a> Unpin for ExportSvgOptions<'a>

§

impl<'a> UnsafeUnpin for ExportSvgOptions<'a>

§

impl<'a> UnwindSafe for ExportSvgOptions<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.