[−][src]Struct orgize::export::SyntectHtmlHandler

pub struct SyntectHtmlHandler<E: From<Error>, H: HtmlHandler<E>> {
    pub syntax_set: SyntaxSet,
    pub theme_set: ThemeSet,
    pub theme: String,
    pub inner: H,
    pub background: IncludeBackground,
    pub error_type: PhantomData<E>,
}

Syntect Html Handler

Simple Usage:

use orgize::Org;
use orgize::export::{DefaultHtmlHandler, SyntectHtmlHandler};

let mut handler = SyntectHtmlHandler::new(DefaultHtmlHandler);
let org = Org::parse("src_rust{println!(\"Hello\")}");

let mut vec = vec![];

org.write_html_custom(&mut vec, &mut handler).unwrap();

Customize:

// orgize has re-exported the whole syntect crate
use orgize::syntect::parsing::SyntaxSet;
use orgize::export::{DefaultHtmlHandler, SyntectHtmlHandler};

let mut handler = SyntectHtmlHandler {
    syntax_set: {
        let set = SyntaxSet::load_defaults_newlines();
        let mut builder = set.into_builder();
        // add extra language syntax
        builder.add_from_folder("path/to/syntax/dir", true).unwrap();
        builder.build()
    },
    // specify theme
    theme: String::from("Solarized (dark)"),
    inner: DefaultHtmlHandler,
    ..Default::default()
};

// Make sure to check if theme presents or it will panic at runtime
if handler.theme_set.themes.contains_key("dont-exists") {

}

Fields

syntax_set: SyntaxSet

syntax set, default is SyntaxSet::load_defaults_newlines()

theme_set: ThemeSet

theme set, default is ThemeSet::load_defaults()

theme: String

theme used for highlighting, default is "InspiredGitHub"

inner: H

inner html handler

background: IncludeBackground

background color, default is IncludeBackground::No

error_type: PhantomData<E>

handler error type

Implementations

impl<E: From<Error>, H: HtmlHandler<E>> SyntectHtmlHandler<E, H>[src]

pub fn new(inner: H) -> Self[src]

Trait Implementations

impl<E: From<Error>, H: HtmlHandler<E>> Default for SyntectHtmlHandler<E, H>[src]

impl<E: From<Error>, H: HtmlHandler<E>> HtmlHandler<E> for SyntectHtmlHandler<E, H>[src]

Auto Trait Implementations

impl<E, H> !RefUnwindSafe for SyntectHtmlHandler<E, H>

impl<E, H> Send for SyntectHtmlHandler<E, H> where
    E: Send,
    H: Send, 

impl<E, H> Sync for SyntectHtmlHandler<E, H> where
    E: Sync,
    H: Sync, 

impl<E, H> Unpin for SyntectHtmlHandler<E, H> where
    E: Unpin,
    H: Unpin, 

impl<E, H> UnwindSafe for SyntectHtmlHandler<E, H> where
    E: UnwindSafe,
    H: UnwindSafe, 

Blanket Implementations

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

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.