latexify 0.1.0

Shared definition for turn a rust object into latex code
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

#![deny(missing_debug_implementations, missing_copy_implementations)]
#![warn(missing_docs, rustdoc::missing_crate_level_docs)]
#![doc = include_str!("../readme.md")]
#![doc(html_logo_url = "https://raw.githubusercontent.com/oovm/shape-rs/dev/projects/images/Trapezohedron.svg")]
#![doc(html_favicon_url = "https://raw.githubusercontent.com/oovm/shape-rs/dev/projects/images/Trapezohedron.svg")]

use core::fmt::Write;

mod for_3rd;
mod for_std;

// noinspection SpellCheckingInspection
/// A trait for LaTeX representation.
pub trait Latexify {
    /// The context of LaTeX representation.
    type Context;
    /// Write LaTeX representation to the formatter.
    ///
    /// # Examples
    ///
    /// ```
    /// use latexify::Latexify;
    /// # fn main() -> std::fmt::Result {
    /// let mut buffer = String::new();
    /// Latexify::fmt(&0, &mut buffer)?;
    /// println!("{}", buffer); // 0
    /// //
    /// # Ok(())
    /// # }
    /// ```
    fn fmt<W: Write>(&self, c: &Self::Context, f: &mut W) -> core::fmt::Result;
    /// Get the LaTeX string of raw object.
    ///
    /// # Examples
    ///
    /// ```
    /// use latexify::Latexify;
    /// 0.to_latex(); // "0"
    /// ```
    fn to_latex(&self, config: &Self::Context) -> String {
        let mut s = String::new();
        Latexify::fmt(self, config, &mut s).unwrap();
        s
    }
}