Struct OrgModeFormatter

pub struct OrgModeFormatter;

Implementations

impl OrgModeFormatter

pub const fn new() -> Self

pub fn drawer<S>(&self, name: S) -> String

where S: AsRef<str>,

pub fn drawer_with_content<S1, S2>(&self, name: S1, content: S2) -> String

where S1: AsRef<str>, S2: AsRef<str>,

pub fn property_drawer(&self, properties: HashMap<String, String>) -> String

pub fn property<S1, S2>(&self, name: S1, value: S2) -> String

where S1: AsRef<str>, S2: AsRef<str>,

pub fn logbook_drawer<S1, S2, S3>( &self, log_entries: &[(S1, S2, Option<S3>)], ) -> String

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>,

pub fn log_entry<S1, S2, S3>( &self, headline: S1, date: S2, note: Option<S3>, ) -> String

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>,

Trait Implementations

impl BlockFormat<SourceBlockArguments> for OrgModeFormatter

fn heading<S>(&self, text: S, depth: usize) -> String

where S: AsRef<str>,

fn heading_with_id<S1, S2>(&self, text: S1, depth: usize, id: S2) -> String

where S1: AsRef<str>, S2: AsRef<str>,

fn pseudo_heading<S>(&self, s: S) -> String

where S: AsRef<str>,

fn pseudo_heading_with_id<S1, S2>(&self, text: S1, id: S2) -> String

where S1: AsRef<str>, S2: AsRef<str>,

fn paragraph<S>(&self, s: S) -> String

where S: AsRef<str>,

fn quote<S>(&self, s: S) -> String

where S: AsRef<str>,

fn verbatim<S>(&self, s: S) -> String

where S: AsRef<str>,

fn indented_verbatim<S>(&self, s: S) -> String

where S: AsRef<str>,

fn example<S>(&self, s: S) -> String

where S: AsRef<str>,

fn export<S>(&self, s: S) -> String

where S: AsRef<str>,

fn center<S>(&self, s: S) -> String

where S: AsRef<str>,

fn comment<S>(&self, s: S) -> String

where S: AsRef<str>,

fn line_comment<S>(&self, s: S) -> String

where S: AsRef<str>,

fn source<S1, S2>( &self, language: S1, src: S2, arguments: SourceBlockArguments, ) -> String

where S1: AsRef<str>, S2: AsRef<str>,

fn source_with<S1, S2, S3, S4>( &self, language: S1, src: S2, arguments: SourceBlockArguments, id: S3, caption: S4, ) -> String

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>, S4: AsRef<str>,

fn inline_source<S1, S2>( &self, language: S1, src: S2, arguments: SourceBlockArguments, ) -> String

where S1: AsRef<str>, S2: AsRef<str>,

fn figure_with<S1, S2, S3, S4>( &self, id: S1, caption: S2, file_name: S3, result_of: Option<S4>, ) -> String

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>, S4: AsRef<str>,

fn caption<S>(&self, text: S) -> String

where S: AsRef<str>,

fn results_of<S>(&self, id: S) -> String

where S: AsRef<str>,

fn ordered_list(&self, items: &[String], indentation: usize) -> String

fn unordered_list(&self, items: &[String], indentation: usize) -> String

fn definition_list(&self, items: &HashMap<String, String>) -> String

fn table_with<S1, S2, S3>( &self, data: &[Vec<S1>], header_row: bool, id: S2, caption: S3, ) -> String

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>,

fn table_header_row<S>(&self, columns: &[S], add_hline: bool) -> String

where S: AsRef<str>,

fn table_hline(&self, widths: &[usize]) -> String

fn table_row<S>(&self, values: &[S]) -> String

where S: AsRef<str>,

fn table<S>(&self, data: &[Vec<S>], header_row: bool) -> String

where S: AsRef<str>,

impl Clone for OrgModeFormatter

fn clone(&self) -> OrgModeFormatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrgModeFormatter

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

Formats the value using the given formatter.

impl Default for OrgModeFormatter

fn default() -> OrgModeFormatter

Returns the “default value” for a type.

impl DocumentationWriter<IncludeArguments, SourceBlockArguments, OrgModeFormatter> for DocumentationGenerator

fn formatter() -> &'static OrgModeFormatter

fn write_book<T>( &mut self, loader: &mut T, cache: &mut impl ModuleStore, config: BookConfig, ) -> Result<(), Error>

where T: ModuleLoader,

fn write_preamble<W>( &mut self, title: &str, language: &str, include_toc: bool, writer: &mut W, ) -> Result<(), Error>

where W: Write + Sized,

fn write_module_description<W>( &mut self, heading: Heading, module: &Module, _: &impl ModuleStore, writer: &mut W, ) -> Result<(), Error>

where W: Write + Sized,

fn write_module_definitions<W>( &mut self, heading_level: u8, module: &Module, cache: &impl ModuleStore, writer: &mut W, ) -> Result<(), Error>

where W: Write + Sized,

fn write_module_uml_overview<W>( &mut self, module: &Module, _: &impl ModuleStore, writer: &mut W, ) -> Result<(), Error>

where W: Write + Sized,

fn write_module_sdml_listing<W>( &mut self, heading: Heading, module: &Module, writer: &mut W, ) -> Result<(), Error>

where W: Write + Sized,

fn write_module_rdf_listing<W>( &mut self, heading: Heading, module: &Module, cache: &impl ModuleStore, writer: &mut W, ) -> Result<(), Error>

where W: Write + Sized,

fn write_module_dependency_table<W>( &mut self, module: &Module, cache: &impl ModuleStore, writer: &mut W, ) -> Result<(), Error>

where W: Write + Sized,

fn write_module_dependency_graph<W>( &mut self, heading: Heading, module: &Module, cache: &impl ModuleStore, writer: &mut W, ) -> Result<(), Error>

where W: Write + Sized,

impl LinkFormat for OrgModeFormatter

fn noweb_target<S>(&self, s: S) -> String

where S: AsRef<str>,

fn name_target<S>(&self, s: S) -> String

where S: AsRef<str>,

fn make_id_link<S>(&self, id: S) -> String

where S: AsRef<str>,

fn make_heading_link<S>(&self, heading: S) -> String

where S: AsRef<str>,

fn link<S>(&self, target: S) -> String

where S: AsRef<str>,

fn link_with_description<S1, S2>(&self, target: S1, description: S2) -> String

where S1: AsRef<str>, S2: AsRef<str>,

impl PageFormat<IncludeArguments> for OrgModeFormatter

fn title<S>(&self, s: S) -> String

where S: AsRef<str>,

fn language<S>(&self, s: S) -> String

where S: AsRef<str>,

fn style_uri<S>(&self, s: S) -> String

where S: AsRef<str>,

fn style_inline<S>(&self, s: S) -> String

where S: AsRef<str>,

fn options<S>(&self, s: S) -> String

where S: AsRef<str>,

fn include_file<S>(&self, s: S) -> String

where S: AsRef<str>,

fn include_file_with_args<S>(&self, s: S, arguments: IncludeArguments) -> String

where S: AsRef<str>,

impl PartialEq for OrgModeFormatter

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

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

const 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 TextFormat for OrgModeFormatter

fn bold<S>(&self, s: S) -> String

where S: AsRef<str>,

fn italic<S>(&self, s: S) -> String

where S: AsRef<str>,

fn underline<S>(&self, s: S) -> String

where S: AsRef<str>,

fn mono<S>(&self, s: S) -> String

where S: AsRef<str>,

fn code<S>(&self, s: S) -> String

where S: AsRef<str>,

fn strikethrough<S>(&self, s: S) -> String

where S: AsRef<str>,

fn superscript<S>(&self, s: S) -> String

where S: AsRef<str>,

fn subscript<S>(&self, s: S) -> String

where S: AsRef<str>,

impl Copy for OrgModeFormatter

impl Formatter<IncludeArguments, SourceBlockArguments> for OrgModeFormatter

impl StructuralPartialEq for OrgModeFormatter