Skip to main content

FormatBuilder

Struct FormatBuilder 

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

Bakes a packaged format: INITEX runs an optional kernel file, then the preamble, then dumps.

Implementations§

Source§

impl FormatBuilder

Source

pub fn new(preamble: impl Into<String>) -> Self

A format whose INITEX run reads preamble, which should not \dump itself.

Examples found in repository?
examples/bake_format.rs (line 25)
11fn main() -> ExitCode {
12    let mut args = std::env::args_os().skip(1);
13    let (Some(output), None) = (args.next().map(PathBuf::from), args.next()) else {
14        eprintln!("usage: bake_format <output.pkg>");
15        return ExitCode::FAILURE;
16    };
17    let texmf = match TexmfResources::discover() {
18        Ok(texmf) => texmf,
19        Err(error) => {
20            eprintln!("bake_format: {error}");
21            return ExitCode::FAILURE;
22        }
23    };
24    let fonts = ResourceFontLoader::new(&texmf);
25    let format = match FormatBuilder::new(PREAMBLE)
26        .kernel("latex.ltx")
27        .build(&texmf, &fonts)
28    {
29        Ok(format) => format,
30        Err(error) => {
31            eprintln!("bake_format: {error}");
32            return ExitCode::FAILURE;
33        }
34    };
35    if let Err(error) = std::fs::write(&output, &format) {
36        eprintln!("bake_format: cannot write {}: {error}", output.display());
37        return ExitCode::FAILURE;
38    }
39    eprintln!(
40        "bake_format: wrote {} bytes to {}",
41        format.len(),
42        output.display()
43    );
44    ExitCode::SUCCESS
45}
Source

pub fn kernel(self, file: impl Into<String>) -> Self

Runs file, such as latex.ltx, through INITEX to its own \dump before the preamble.

Examples found in repository?
examples/bake_format.rs (line 26)
11fn main() -> ExitCode {
12    let mut args = std::env::args_os().skip(1);
13    let (Some(output), None) = (args.next().map(PathBuf::from), args.next()) else {
14        eprintln!("usage: bake_format <output.pkg>");
15        return ExitCode::FAILURE;
16    };
17    let texmf = match TexmfResources::discover() {
18        Ok(texmf) => texmf,
19        Err(error) => {
20            eprintln!("bake_format: {error}");
21            return ExitCode::FAILURE;
22        }
23    };
24    let fonts = ResourceFontLoader::new(&texmf);
25    let format = match FormatBuilder::new(PREAMBLE)
26        .kernel("latex.ltx")
27        .build(&texmf, &fonts)
28    {
29        Ok(format) => format,
30        Err(error) => {
31            eprintln!("bake_format: {error}");
32            return ExitCode::FAILURE;
33        }
34    };
35    if let Err(error) = std::fs::write(&output, &format) {
36        eprintln!("bake_format: cannot write {}: {error}", output.display());
37        return ExitCode::FAILURE;
38    }
39    eprintln!(
40        "bake_format: wrote {} bytes to {}",
41        format.len(),
42        output.display()
43    );
44    ExitCode::SUCCESS
45}
Source

pub fn build( self, resources: &impl ResourceProvider, fonts: &impl FontLoader, ) -> Result<Vec<u8>, BuildError>

Runs the kernel and preamble, defines \hostbox if still undefined, and returns the packaged format.

Examples found in repository?
examples/bake_format.rs (line 27)
11fn main() -> ExitCode {
12    let mut args = std::env::args_os().skip(1);
13    let (Some(output), None) = (args.next().map(PathBuf::from), args.next()) else {
14        eprintln!("usage: bake_format <output.pkg>");
15        return ExitCode::FAILURE;
16    };
17    let texmf = match TexmfResources::discover() {
18        Ok(texmf) => texmf,
19        Err(error) => {
20            eprintln!("bake_format: {error}");
21            return ExitCode::FAILURE;
22        }
23    };
24    let fonts = ResourceFontLoader::new(&texmf);
25    let format = match FormatBuilder::new(PREAMBLE)
26        .kernel("latex.ltx")
27        .build(&texmf, &fonts)
28    {
29        Ok(format) => format,
30        Err(error) => {
31            eprintln!("bake_format: {error}");
32            return ExitCode::FAILURE;
33        }
34    };
35    if let Err(error) = std::fs::write(&output, &format) {
36        eprintln!("bake_format: cannot write {}: {error}", output.display());
37        return ExitCode::FAILURE;
38    }
39    eprintln!(
40        "bake_format: wrote {} bytes to {}",
41        format.len(),
42        output.display()
43    );
44    ExitCode::SUCCESS
45}

Trait Implementations§

Source§

impl Clone for FormatBuilder

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 Debug for FormatBuilder

Source§

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

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

impl Eq for FormatBuilder

Source§

impl PartialEq for FormatBuilder

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FormatBuilder

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, 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.