Inkjet

https://docs.rs/inkjet/0.11.1/inkjet/
Admin
Inkjet is a batteries-included syntax highlighting library for Rust that supports 100+ programming...
Tokens:143,654
Snippets:332
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Inkjet - Getting Started

Source: https://docs.rs/inkjet

Information on how to get started with syntax highlighting using the Inkjet library.

```APIDOC
## Getting Started with Inkjet

Inkjet is a batteries-included syntax highlighting library for Rust, based on `tree-sitter`.

### Core Components

*   **`Highlighter`**: The main type for performing syntax highlighting.
*   **`formatter` module**: Provides options for outputting highlighted code.
*   **`theme` module**: Offers an optional API for customizing highlighting themes.
*   **`Formatter` trait**: For implementing custom formatters.

### Basic Usage

To get started with highlighting, take a look at the `Highlighter` type.
See the `formatter` module for the output options bundled with Inkjet, and the `theme` module for the optional theming API.
If you’d like to write your own formatter, see the `Formatter` trait.
```

--------------------------------

### Implement Formatter::start_io

Source: https://docs.rs/inkjet/0.11.1/inkjet/formatter/trait.Formatter.html

Optional method for initial formatter operations using `std::io::Write`. The default implementation is a no-op. It shells out to the `start` method.

```rust
fn start_io<W>(&self, source: &str, writer: &mut W) -> Result<()>
       where W: Write {
```

--------------------------------

### Example HTML Output

Source: https://docs.rs/inkjet/0.11.1/inkjet/formatter/struct.ThemedHtml.html

Illustrates the typical HTML output generated by the ThemedHtml formatter, including inline styles for syntax highlighting.

```html
<pre style="background-color: #cccccc">
    <span style="color:#f85931">fn</span><span style="color:#f85931">main</span>
</pre>
```

--------------------------------

### Example HTML output

Source: https://docs.rs/inkjet/0.11.1/inkjet/struct.Highlighter.html

The resulting HTML structure produced by the default HTML formatter.

```html
<span class="keyword function">fn</span> <span class="function">main</span><span class="punctuation bracket">(</span><span class="punctuation bracket">)</span> <span class="punctuation bracket">{</span>
    <span class="function macro">println</span><span class="function macro">!</span><span class="punctuation bracket">(</span><span class="string">&quot;Hello, world!&quot;</span><span class="punctuation bracket">)</span><span class="punctuation delimiter"></span><span class="punctuation delimiter">;</span>
<span class="punctuation bracket">}</span>
```

--------------------------------

### Runtime Language Highlighting Example

Source: https://docs.rs/inkjet/0.11.1/inkjet/enum.Language.html

Demonstrates how to use the `Runtime` variant of the `Language` enum to highlight code with a language configuration determined at runtime. This requires a function that returns a `HighlightConfiguration`.

```rust
fn rust_config() -> &'static HighlightConfiguration {
    Language::Rust.config()
}

let code = r#"
    fn main() {
        println!("Hello, world!");
    }
"#;

let mut highlighter = Highlighter::new();

let _string = highlighter.highlight_to_string(
    Language::Runtime(rust_config),
    &formatter::Html,
    code
)
.expect("Highlighting should not fail");

```

--------------------------------

### Implement Formatter::write

Source: https://docs.rs/inkjet/0.11.1/inkjet/formatter/trait.Formatter.html

Required method to format a `HighlightEvent` into an instance of `std::fmt::Write`. The `Html` formatter provides an example implementation.

```rust
fn write<W>( 
        &self, 
        source: &str, 
        writer: &mut W, 
        event: HighlightEvent, 
    ) -> Result<()>
       where W: Write,
```

--------------------------------

### Get references to Result values

Source: https://docs.rs/inkjet/0.11.1/inkjet/type.Result.html

Use `as_ref()` to get references to the contained values of a `Result` without consuming it. This is useful when you need to inspect the values without taking ownership.

```Rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.as_ref(), Ok(&2));

let x: Result<u32, &str> = Err("Error");
assert_eq!(x.as_ref(), Err(&"Error"));
```

--------------------------------

### Implement Formatter::start

Source: https://docs.rs/inkjet/0.11.1/inkjet/formatter/trait.Formatter.html

Optional method for initial formatter operations using `std::fmt::Write`. The default implementation is a no-op. Useful for writing boilerplate before the first event.

```rust
fn start<W>(&self, source: &str, writer: &mut W) -> Result<()>
       where W: Write {
```

--------------------------------

### Trait Formatter

Source: https://docs.rs/inkjet/0.11.1/inkjet/formatter/trait.Formatter.html

The Formatter trait defines the interface for formatting highlighter events. It includes required methods for writing events and optional lifecycle methods for start and finish operations.

```APIDOC
## Trait: inkjet::formatter::Formatter

### Description
A pluggable trait for formatting the output of a highlighter. Implementations define how to process HighlightEvent instances into a writer.

### Required Methods
- **write<W>(source: &str, writer: &mut W, event: HighlightEvent) -> Result<()>**
  - Formats a `HighlightEvent` into an instance of `std::fmt::Write`.

### Provided Methods
- **write_io<W>(source: &str, writer: &mut W, event: HighlightEvent) -> Result<()>**
  - Formats a `HighlightEvent` into an instance of `std::io::Write`.
- **start<W>(&self, source: &str, writer: &mut W) -> Result<()>**
  - Optional method for one-off initial formatter operations (`std::fmt::Write` version).
- **finish<W>(&self, source: &str, writer: &mut W) -> Result<()>**
  - Optional method for one-off final formatter operations (`std::fmt::Write` version).
- **start_io<W>(&self, source: &str, writer: &mut W) -> Result<()>**
  - Optional method for one-off initial formatter operations (`std::io::Write` version).
- **finish_io<W>(&self, source: &str, writer: &mut W) -> Result<()>**
  - Optional method for one-off final formatter operations (`std::io::Write` version).

### Notes
- This trait is **not** dyn compatible.
- Implementors include `Html`, `Terminal`, and `ThemedHtml` (subject to feature flags).
```

--------------------------------

### Terminal::new

Source: https://docs.rs/inkjet/0.11.1/inkjet/formatter/struct.Terminal.html

Creates a new instance of the Terminal formatter.

```APIDOC
## Terminal::new

### Description
Creates a new `Terminal` instance with the specified theme and output stream.

### Parameters
- **theme** (Theme) - Required - The theme configuration for highlighting.
- **stream** (StandardStream) - Required - The output stream for the terminal.

### Response
- **Terminal** (Self) - A new instance of the Terminal formatter.
```

--------------------------------

### Highlighter API

Source: https://docs.rs/inkjet/0.11.1/inkjet/struct.Highlighter.html

Methods for creating a highlighter and performing syntax highlighting operations.

```APIDOC
## Highlighter::new

### Description
Creates a new instance of the Highlighter.

### Method
Constructor

## Highlighter::highlight_to_string

### Description
Highlights source code into a new String using the provided formatter.

### Parameters
- **lang** (Language) - Required - The language of the source code.
- **formatter** (F: Formatter) - Required - The formatter to use for styling.
- **source** (S: AsRef<str>) - Required - The source code to highlight.

### Response
- **Result<String>** - The highlighted code as a string.

## Highlighter::highlight_to_writer

### Description
Highlights source code into an instance of std::io::Write using the provided formatter.

### Parameters
- **lang** (Language) - Required - The language of the source code.
- **formatter** (F: Formatter) - Required - The formatter to use.
- **source** (S: AsRef<str>) - Required - The source code.
- **output** (O: Write) - Required - The writer to output the result to.

## Highlighter::highlight_raw

### Description
Advanced method for direct access to the underlying HighlightEvent iterator.

### Parameters
- **lang** (Language) - Required - The language of the source code.
- **source** (S: AsRef<str>) - Required - The source code.

### Response
- **Result<impl Iterator<Item = Result<HighlightEvent>>>** - An iterator over the highlight events.
```

--------------------------------

### Highlight code to writer or string

Source: https://docs.rs/inkjet/0.11.1/inkjet/struct.Highlighter.html

Demonstrates using highlight_to_writer and highlight_to_string to process code into formatted output.

```rust
let code = r#"
    fn main() {
        println!("Hello, world!");
    }
"#;
 
// Highlighting into the void
let _ = highlighter.highlight_to_writer(
    Language::Rust,
    &formatter::Html,
    code,
    &mut io::sink()
)?;
 
let string = highlighter.highlight_to_string(
    Language::Rust,
    &formatter::Html,
    code
)?;
```

--------------------------------

### Safely Get Err Value (Nightly)

Source: https://docs.rs/inkjet/0.11.1/inkjet/type.Result.html

The `into_err` method (nightly-only) safely returns the `Err` value of a `Result` without panicking. It's a compile-time safeguard against future ok type changes.

```rust
fn only_bad_news() -> Result<!, String> {
    Err("Oops, it failed".into())
}

let error: String = only_bad_news().into_err();
println!("{error}");
```

--------------------------------

### Safely Get Ok Value (Nightly)

Source: https://docs.rs/inkjet/0.11.1/inkjet/type.Result.html

The `into_ok` method (nightly-only) safely returns the `Ok` value of a `Result` without panicking. It's a compile-time safeguard against future error type changes.

```rust
fn only_good_news() -> Result<String, !> {
    Ok("this is fine".into())
}

let s: String = only_good_news().into_ok();
println!("{s}");
```

--------------------------------

### Implement Default for Style

Source: https://docs.rs/inkjet/0.11.1/inkjet/theme/struct.Style.html

Provides a default `Style` value, typically representing no specific styling.

```rust
fn default() -> Self
```

--------------------------------

### Convert Result<u32, &str> to Vec<u32> (Err case)

Source: https://docs.rs/inkjet/0.11.1/inkjet/type.Result.html

Converts a Result containing an Err value into an iterator and collects it into a Vec. This example shows the failure case where the iterator yields no values.

```rust
let x: Result<u32, &str> = Err("nothing!");
let v: Vec<u32> = x.into_iter().collect();
assert_eq!(v, []);
```

--------------------------------

### Convert token to Language

Source: https://docs.rs/inkjet/0.11.1/inkjet/enum.Language.html

Demonstrates converting a string token into a Language variant using from_token.

```rust
assert_eq!(
    Language::from_token("rs").unwrap(),
    Language::Rust
);
```

--------------------------------

### Convert Result<u32, &str> to Vec<u32> (Ok case)

Source: https://docs.rs/inkjet/0.11.1/inkjet/type.Result.html

Converts a Result containing an Ok value into an iterator and collects it into a Vec. This example shows the successful case where the Ok value is present.

```rust
let x: Result<u32, &str> = Ok(5);
let v: Vec<u32> = x.into_iter().collect();
assert_eq!(v, [5]);
```

--------------------------------

### Trait Implementations Overview

Source: https://docs.rs/inkjet/0.11.1/inkjet/theme/struct.Color.html

Documentation for standard Rust traits used for type conversion and ownership.

```APIDOC
## Into<U>

### Description
Converts a value into another type U using the implementation of From<T> for U.

### Method
fn into(self) -> U

## ToOwned

### Description
Creates owned data from borrowed data, usually by cloning.

### Methods
- type Owned = T
- fn to_owned(&self) -> T
- fn clone_into(&self, target: &mut T)

## TryFrom<U>

### Description
Performs a fallible conversion from type U to T.

### Methods
- type Error = Infallible
- fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

## TryInto<U>

### Description
Performs a fallible conversion into type U.

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

## DeserializeOwned

### Description
Trait for types that can be deserialized from a data source without borrowing.
```

--------------------------------

### Collect into Result<Vec<u32>, &str> with underflow side effect

Source: https://docs.rs/inkjet/0.11.1/inkjet/type.Result.html

Demonstrates that collection stops upon the first Err. This example shows that a side effect (shared += x) only applies to elements processed before the underflow.

```rust
let v = vec![3, 2, 1, 10];
let mut shared = 0;
let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {
    shared += x;
    x.checked_sub(2).ok_or("Underflow!")
}).collect();
assert_eq!(res, Err("Underflow!"));
assert_eq!(shared, 6);
```

--------------------------------

### Clone::clone_into

Source: https://docs.rs/inkjet/0.11.1/inkjet/enum.Language.html

This is a nightly-only experimental API. It performs copy-assignment from self to dest.

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

### Description
This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`.

### Method
unsafe fn

### Endpoint
N/A (Method implementation)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Calculate Sum of Iterator Items in Result

Source: https://docs.rs/inkjet/0.11.1/inkjet/type.Result.html

Calculates the sum of items in an iterator where each item is a `Result`. If any item is an `Err`, it's returned immediately. Otherwise, the sum of all `Ok` values is returned. This example specifically rejects negative elements.

```rust
let f = |&x: &i32| if x < 0 { Err("Negative element found") } else { Ok(x) };
let v = vec![1, 2];
let res: Result<i32, _> = v.iter().map(f).sum();
assert_eq!(res, Ok(3));
```

```rust
let f = |&x: &i32| if x < 0 { Err("Negative element found") } else { Ok(x) };
let v = vec![1, -2];
let res: Result<i32, _> = v.iter().map(f).sum();
assert_eq!(res, Err("Negative element found"));
```

--------------------------------

### GitHub Light Theme Configuration

Source: https://docs.rs/inkjet/0.11.1/inkjet/theme/vendored/constant.GITHUB_LIGHT.html

Defines the color mappings for syntax highlighting and UI elements in the GitHub Light theme. This configuration is used to style code and interface components.

```toml
pub const GITHUB_LIGHT: &str = "# Author : OwOSwordsman <owoswordsman@gmail.com>\n# An unofficial GitHub theme, generated using colors from: https://primer.style/primitives/colors\n# Credit goes to the original VSCode theme: https://github.com/primer/github-vscode-theme\n# Only the Light and Dark variants were specifically tested\n\nattribute = \"fg.default\"\nkeyword = \"scale.red.5\"\n\"keyword.directive\" = \"scale.red.5\"          # -- preprocessor comments (#if in C)\nnamespace = \"scale.orange.6\"\npunctuation = \"fg.default\"\n\"punctuation.delimiter\" = \"fg.default\"\noperator = \"scale.blue.8\"\nspecial = \"scale.blue.8\"\n\"variable.other.member\" = \"scale.blue.8\"\nvariable = \"fg.default\"\n\"variable.parameter\" = \"scale.orange.6\"\n\"variable.builtin\" = \"scale.red.5\"\ntype = \"scale.orange.6\"\n\"type.builtin\" = \"scale.blue.6\"\nconstructor = \"done.fg\"\nfunction = \"done.fg\"\n\"function.macro\" = \"done.fg\"\ntag = \"scale.green.6\"\ncomment = \"fg.muted\"\nconstant = \"scale.blue.6\"\n\"constant.builtin\" = \"scale.blue.6\"\nstring = \"scale.blue.8\"\n\"constant.numeric\" = \"scale.blue.6\"\n\"constant.character.escape\" = \"scale.blue.6\"\n# used for lifetimes\nlabel = \"scale.red.5\"\n\n\"markup.heading\" = \"scale.blue.6\"\n\"markup.bold\" = { modifiers = [\"bold\"] }\n\"markup.italic\" = { modifiers = [\"italic\"] }\n\"markup.strikethrough\" = { modifiers = [\"crossed_out\"] }\n\"markup.link.url\" = { modifiers = [\"underlined\"] }\n\"markup.link.text\" = { fg = \"scale.blue.8\", modifiers = [\"underlined\"] }\n\"markup.raw\" = \"scale.blue.6\"\n\n\"diff.plus\" = \"open.fg\"\n\"diff.minus\" = \"closed.fg\"\n\"diff.delta\" = \"attention.fg\"\n\n\"ui.background\" = { bg = \"canvas.default\" }\n\"ui.background.separator\" = { fg = \"fg.subtle\" }\n\"ui.linenr\" = { fg = \"fg.subtle\" }\n\"ui.linenr.selected\" = { fg = \"fg.default\" }\n\"ui.statusline\" = { fg = \"fg.muted\", bg = \"neutral.subtle\" }\n\"ui.statusline.active\" = { fg = \"fg.default\", bg = \"canvas.default\", underline = { color = \"scale.coral.3\", style = \"line\" } }\n\"ui.statusline.normal\" = { fg = \"fg.default\", bg = \"accent.muted\" }\n\"ui.statusline.insert\" = { fg = \"fg.default\", bg = \"attention.muted\" }\n\"ui.statusline.select\" = { fg = \"fg.default\", bg = \"sponsors.muted\" }\n\"ui.popup\" = { bg = \"scale.gray.0\" }\n\"ui.popup.info\" = { fg = \"fg.default\", bg = \"scale.gray.0\" }\n\"ui.window\" = { fg = \"border.default\" }\n\"ui.help\" = { fg = \"fg.default\", bg = \"scale.gray.0\" }\n\n\"ui.text\" = { fg = \"fg.muted\" }\n\"ui.text.focus\" = { fg = \"fg.default\" }\n\"ui.text.inactive\" = \"fg.subtle\"\n\"ui.virtual\" = { fg = \"scale.gray.2\" }\n\"ui.virtual.ruler\" = { bg = \"canvas.subtle\" }\n\n\"ui.selection\" = { bg = \"scale.blue.0\" }\n\"ui.selection.primary\" = { bg = \"scale.blue.1\" }\n\"ui.cursor.match\" = { fg = \"attention.fg\", modifiers = [\n    \"bold\",\n  ], underline = { style = \"line\" } }\n\"ui.cursor\" = { modifiers = [\"reversed\"] }\n\"ui.cursorline.primary\" = { bg = \"canvas.subtle\" }\n\n\"ui.menu\" = { fg = \"fg.default\", bg = \"scale.gray.0\" }\n\"ui.menu.selected\" = { bg = \"scale.gray.1\" }\n\"ui.menu.scroll\" = { fg = \"scale.gray.2\", bg = \"scale.gray.0\" }\n\n\"diagnostic.hint\" = { underline = { color = \"success.fg\", style = \"curl\" } }\n\"diagnostic.info\" = { underline = { color = \"accent.fg\", style = \"curl\" } }\n\"diagnostic.warning\" = { underline = { color = \"attention.fg\", style = \"curl\" } }\n\"diagnostic.error\" = { underline = { color = \"danger.fg\", style = \"curl\" } }\n\"diagnostic.unnecessary\" = { modifiers = [\"dim\"] }\n\"diagnostic.deprecated\" = { modifiers = [\"crossed_out\"] }\n\nhint = \"success.fg\"\ninfo = \"accent.fg\"\nwarning = \"attention.fg\"\nerror = \"danger.fg\"\n\n[palette]\n\"accent.emphasis\" = \"#0969da\"\n\"accent.fg\" = \"#0969da\"\n\"accent.muted\" = \"#54aeff66\"\n\"accent.subtle\" = \"#ddf4ff\"\n\"attention.emphasis\" = \"#bf8700\"\n\"attention.fg\" = \"#9a6700\"\n\"attention.muted\" = \"#d4a72c66\"\n\"attention.subtle\" = \"#fff8c5\"\n\"border.default\" = \"#d0d7de\"\n\"border.muted\" = \"#d8dee4\"\n\"border.subtle\" = \"#1b1f2426\"\n\"canvas.default\" = \"#ffffff\"\n\"canvas.inset\" = \"#f6f8fa\"\n\"canvas.overlay\" = \"#ffffff\"\n\"canvas.subtle\" = \"#f6f8fa\"\n\"closed.emphasis\" = \"#cf222e\"\n\"closed.fg\" = \"#cf222e\"\n\"closed.muted\" = \"#ff818266\"\n\"closed.subtle\" = \"#ffebe9\"\n\"danger.emphasis\" = \"#cf222e\"\n\"danger.fg\" = \"#cf222e\"\n\"danger.muted\" = \"#ff818266\"\n\"danger.subtle\" = \"#ffebe9\"\n\"done.emphasis\" = \"#8250df\"\n\"done.fg\" = \"#8250df\"\n\"done.muted\" = \"#c297ff66\"\n\"done.subtle\" = \"#fbefff\"\n\"fg.default\" = \"#24292f\"\n\"fg.muted\" = \"#57606a\"\n\"fg.onEmphasis\" = \"#ffffff\"\n\"fg.subtle\" = \"#6e7781\"\n\"neutral.emphasis\" = \"#6e7781\"\n\"neutral.emphasisPlus\" = \"#24292f\"
```

--------------------------------

### Convert Result<T, E> to Result<&<T as Deref>::Target, &E> in Rust

Source: https://docs.rs/inkjet/0.11.1/inkjet/type.Result.html

Converts from `Result<T, E>` to `Result<&<T as Deref>::Target, &E>` by coercing the `Ok` variant via `Deref`. Useful for getting references to the dereferenced value without consuming the original Result.

```rust
let x: Result<String, u32> = Ok("hello".to_string());
let y: Result<&str, &u32> = Ok("hello");
assert_eq!(x.as_deref(), y);

let x: Result<String, u32> = Err(42);
let y: Result<&str, &u32> = Err(&42);
assert_eq!(x.as_deref(), y);
```

--------------------------------

### Implement From<Color> for Style

Source: https://docs.rs/inkjet/0.11.1/inkjet/theme/struct.Style.html

Enables creating a `Style` instance directly from a `Color` value.

```rust
fn from(value: Color) -> Self
```

--------------------------------

### SERIKA_DARK Constant

Source: https://docs.rs/inkjet/0.11.1/inkjet/theme/vendored/constant.SERIKA_DARK.html

Access the SERIKA_DARK theme configuration string, which defines syntax highlighting and UI colors.

```APIDOC
## GET /inkjet/theme/vendored/SERIKA_DARK

### Description
Retrieves the SERIKA_DARK theme configuration string. This constant contains the color palette and UI element definitions for the Serika Dark theme.

### Method
GET

### Endpoint
inkjet::theme::vendored::SERIKA_DARK

### Response
#### Success Response (200)
- **body** (string) - The full TOML-formatted theme configuration string.
```

--------------------------------

### Accessing the SERIKA_LIGHT theme constant

Source: https://docs.rs/inkjet/0.11.1/inkjet/theme/vendored/constant.SERIKA_LIGHT.html

This constant defines the color palette and syntax highlighting rules for the Serika Light theme. It requires the 'theme' crate feature to be enabled.

```rust
pub const SERIKA_LIGHT: &str = "# Serika (Light)\n# Author: VuiMuich\n\n# Original Author:\n# URL: https://github.com/arturoalviar/serika-syntax\n# Author: arturoalviar\n# License: MIT License\n\n\"escape\" = \"orange\"\n\"type\" = \"yellow\"\n\"constant\" = \"purple\"\n\"number\" = \"purple\"\n\"string\" = \"fg\"\n\"comment\" = \"grey2\"\n\"variable\" = \"yellow\"\n\"variable.builtin\" = \"blue\"\n\"variable.parameter\" = \"yellow\"\n\"variable.property\" = \"yellow\"\n\"label\" = \"aqua\"\n\"punctuation\" = \"grey0\"\n\"punctuation.delimiter\" = \"grey2\"\n\"punctuation.bracket\" = \"fg\"\n\"keyword\" = \"red\"\n\"operator\" = \"grey0\"\n\"function\" = \"green\"\n\"function.builtin\" = \"blue\"\n\"function.macro\" = \"aqua\"\n\"tag\" = \"yellow\"\n\"namespace\" = \"fg\"\n\"attribute\" = \"aqua\"\n\"constructor\" = \"yellow\"\n\"module\" = \"blue\"\n\"special\" = \"orange\"\n\n\"ui.background\" = { bg = \"bg0\" }\n\"ui.cursor\" = { fg = \"bg0\", bg = \"fg\" }\n\"ui.cursor.match\" = { fg = \"grey1\", bg = \"grey2\" }\n\"ui.cursor.insert\" = { fg = \"bg0\", bg = \"bg_yellow\" }\n\"ui.cursor.select\" = { fg = \"bg0\", bg = \"bg_yellow\" }\n\"ui.linenr\" = \"yellow\"\n\"ui.linenr.selected\" = { fg = \"fg\", modifiers = [\"bold\", \"underlined\"] }\n\"ui.cursorline\" = { bg = \"bg01\" }\n\"ui.statusline\" = { fg = \"grey1\", bg = \"bg5\" }\n\"ui.statusline.inactive\" = { fg = \"grey2\", bg = \"bg1\" }\n\"ui.popup\" = { fg = \"bg0\", bg = \"bg5\" }\n\"ui.window\" = { fg = \"bg0\", bg = \"bg5\" }\n\"ui.help\" = { fg = \"bg0\", bg = \"bg5\" }\n\"ui.text\" = \"fg\"\n\"ui.text.focus\" = \"yellow\"\n\"ui.menu\" = { fg = \"bg0\", bg = \"bg3\" }\n\"ui.menu.selected\" = { fg = \"bg0\", bg = \"bg_yellow\" }\n\"ui.selection\" = { fg = \"bg0\", bg = \"bg3\" }\n\"ui.virtual.whitespace\" = { fg = \"bg2\" }\n\"ui.virtual.ruler\" = { bg = \"bg01\" }\n\"ui.virtual.inlay-hint\" = { fg = \"grey2\", modifiers = [\"italic\"] }\n\n\"hint\" = \"blue\"\n\"info\" = \"aqua\"\n\"warning\" = \"yellow\"\n\"error\" = \"nasty-red\"\n\n\"diagnostic.hint\" = { underline = { style = \"curl\", color = \"blue\" } }\n\"diagnostic.info\" = { underline = { style = \"curl\", color = \"aqua\" } }\n\"diagnostic.warning\" = { underline = { style = \"curl\", color = \"yellow\" } }\n\"diagnostic.error\" = { underline = { style = \"curl\", color = \"nasty-red\" } }\n\"diagnostic.unnecessary\" = { modifiers = [\"dim\"] }\n\"diagnostic.deprecated\" = { modifiers = [\"crossed_out\"] }\n\n\"diff.plus\" = { fg = \"bg_green\" }\n\"diff.delta\" = { fg = \"bg_blue\" }\n\"diff.minus\" = { fg = \"nasty-red\" }\n\n\"markup.heading\" = { fg = \"purple\", modifiers = [\"bold\"] }\n\"markup.list\" = \"cyan\"\n\"markup.bold\" = { fg = \"orange\", modifiers = [\"bold\"] }\n\"markup.italic\" = { fg = \"yellow\", modifiers = [\"italic\"] }\n\"markup.strikethrough\" = { modifiers = [\"crossed_out\"] }\n\"markup.link.url\" = \"cyan\"\n\"markup.link.text\" = \"pink\"\n\"markup.quote\" = { fg = \"yellow\", modifiers = [\"italic\"] }\n\"markup.raw\" = { fg = \"fg\" }\n\n[palette]\n\nbg0 = \"#e1e1e3\"\nbg01 = \"#eaeaec\"\nbg1 = \"#494c50\"\nbg2 = \"#55585e\"\nbg3 = \"#61656b\"\nbg4 = \"#6d7278\"\nbg5 = \"#797e86\"\nbg_visual = \"#646669\"\nbg_red = \"#7e2a33\"\nbg_green = \"#86b365\"\nbg_blue = \"#6a89af\"\nbg_yellow = \"#e2b714\"\n\nfg = \"#323437\"\nred = \"#621d28\"\nnasty-red = \"#da3333\"\ndark-red = \"#791717\"\norange = \"#57320f\"\nyellow = \"#9a7d0e\"\ngreen = \"#3f4b34\"\naqua = \"#455054\"\nblue = \"#3f5673\"\npurple = \"#534059\"\ngrey0 = \"#aaaeb3\"\ngrey1 = \"#e1e1e3\"\ngrey2 = \"#646669\"\npink = \"#e06c75\"\n";
```

--------------------------------

### ThemedHtml::new

Source: https://docs.rs/inkjet/0.11.1/inkjet/formatter/struct.ThemedHtml.html

Creates a new ThemedHtml formatter instance with the provided theme.

```APIDOC
## pub fn new(theme: Theme) -> Self

### Description
Create a new `ThemedHtml` formatter with the given theme.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```rust
// Assuming Theme is defined elsewhere
// let my_theme = Theme::new(); 
// let formatter = ThemedHtml::new(my_theme);
```

### Response
#### Success Response (200)
- `Self`: A new instance of `ThemedHtml`.

#### Response Example
```rust
// Returns an instance of ThemedHtml
```
```

--------------------------------

### Color::new

Source: https://docs.rs/inkjet/0.11.1/inkjet/theme/struct.Color.html

Creates a new Color instance with the provided RGB byte values.

```APIDOC
## Function Color::new

### Description
Create a new `Color` with the provided byte values.

### Parameters
- **r** (u8) - Red byte value.
- **g** (u8) - Green byte value.
- **b** (u8) - Blue byte value.

### Returns
- `Self` - A new `Color` instance.

### Example
```rust
let c = Color::new(0, 255, 0);
```
```

--------------------------------

### Implement Clone for Style

Source: https://docs.rs/inkjet/0.11.1/inkjet/theme/struct.Style.html

Provides functionality to create a duplicate of a `Style` instance.

```rust
fn clone(&self) -> Style
```
Tokens:
Raw