Skip to main content

SqlHighlighter

Struct SqlHighlighter 

Source
pub struct SqlHighlighter { /* private fields */ }
Expand description

SQL highlighting as a CodeHighlighter, for Syntax, Markdown code fences and the console’s code highlighting.

Implementations§

Source§

impl SqlHighlighter

Source

pub fn new() -> Self

SQL only: other languages are plain text.

Source

pub fn with_fallback(fallback: Arc<dyn CodeHighlighter>) -> Self

SQL here, every other language through fallback (syntect, lumis or another engine).

use std::sync::Arc;
use rich::protocol::CodeHighlighter;
use rich_ext::sql::SqlHighlighter;

let both = SqlHighlighter::with_fallback(Arc::new(SqlHighlighter::new()));
assert!(both.languages().contains(&"duckdb".to_string()));
Source

pub fn shared() -> Arc<dyn CodeHighlighter> ⓘ

One shared instance with no fallback.

Trait Implementations§

Source§

impl Clone for SqlHighlighter

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 CodeHighlighter for SqlHighlighter

Source§

fn highlight( &self, code: &str, language: Option<&str>, theme: &str, ) -> Result<HighlightedCode, HighlightError>

Highlight code. language is a name or file extension ("rust", "rs"); None means plain text. theme is one of themes.
Source§

fn default_theme(&self) -> &str

The theme used when none is chosen.
Source§

fn themes(&self) -> Vec<String>

Every theme name highlight accepts.
Source§

fn languages(&self) -> Vec<String>

Language names this highlighter knows, for help text and completion.
Source§

fn language_for_path(&self, path: &Path) -> Option<String>

The language for a file path, if the highlighter recognises it.
Source§

fn token_style(&self, theme: &str, token: &str) -> Option<Style>

theme’s style for a Pygments token type — "Text" or "Comment" — as upstream’s SyntaxTheme.get_style_for_token. Syntax colours its line numbers and indent guides with it; None (the default) means the theme sets nothing for the token.
Source§

impl Debug for SqlHighlighter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SqlHighlighter

Source§

fn default() -> Self

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

Auto Trait Implementations§

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more