Struct OverlayOptions 

pub struct OverlayOptions {
    pub fg: Option<OverlayColorSpec>,
    pub bg: Option<OverlayColorSpec>,
    pub underline: bool,
    pub bold: bool,
    pub italic: bool,
    pub strikethrough: bool,
    pub extend_to_line_end: bool,
    pub fg_on_collision_only: bool,
    pub url: Option<String>,
}

Options for adding an overlay with theme support.

This struct provides a type-safe way to specify overlay styling with optional theme key references for colors.

Fields

fg: Option<OverlayColorSpec>

Foreground color - RGB array or theme key string

bg: Option<OverlayColorSpec>

Background color - RGB array or theme key string

underline: bool

Whether to render with underline

bold: bool

Whether to render in bold

italic: bool

Whether to render in italic

strikethrough: bool

Whether to render with strikethrough

extend_to_line_end: bool

Whether to extend background color to end of line

fg_on_collision_only: bool

When true, fg is applied only on cells whose existing fg matches this overlay’s resolved bg — i.e. a same-colour fg/bg collision. Lets a row-wide overlay stay legible on tokens that share the bg’s colour without repainting unrelated tokens.

url: Option<String>

Optional URL for OSC 8 terminal hyperlinks. When set, the overlay text becomes a clickable hyperlink in terminals that support OSC 8 escape sequences.

Trait Implementations

impl Clone for OverlayOptions

fn clone(&self) -> OverlayOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayOptions

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

Formats the value using the given formatter.

impl Default for OverlayOptions

fn default() -> OverlayOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OverlayOptions

fn deserialize<__D>( __deserializer: __D, ) -> Result<OverlayOptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OverlayOptions

impl PartialEq for OverlayOptions

fn eq(&self, other: &OverlayOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OverlayOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OverlayOptions

impl TS for OverlayOptions

type WithoutGenerics = OverlayOptions

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = OverlayOptions

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where OverlayOptions: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where OverlayOptions: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.