Struct Kpathsea 

pub struct Kpathsea { /* private fields */ }

A configured kpathsea instance.

Implementations

impl Kpathsea

pub fn set_output_directory(&mut self, dir: Option<String>)

The output directory that stands for TEXMF_OUTPUT_DIRECTORY in the checks of Kpathsea::name_ok, instead of the environment’s: LuaTeX sets the variable from -output-directory.

pub fn name_ok( &self, name: &str, access: Access, extended: bool, ) -> Result<(), Refusal>

Checks that file name may be opened for access, like kpsewhich -safe-in-name and its siblings; extended is LuaTeX’s extended check, which also accepts the cache trees.

impl Kpathsea

pub fn new(options: Options) -> Result<Self, Error>

Initializes kpathsea from the process environment.

Examples found in repository

examples/kpsewhich.rs (line 13)

fn main() {
    let args: Vec<String> = std::env::args().collect();
    let fmt = match args.get(1).map(String::as_str) {
        Some("lua") => FileFormat::Lua,
        Some("fmt") => FileFormat::Fmt,
        Some("otf") => FileFormat::OpenType,
        Some("tfm") => FileFormat::Tfm,
        _ => FileFormat::Tex,
    };
    let mut k = Kpathsea::new(Options::lualatex()).unwrap();
    let t = std::time::Instant::now();
    let found = k.find_file(&args[2], fmt);
    eprintln!("path: {:?}", k.search_path(fmt));
    println!("{found:?} ({:?})", t.elapsed());
}

examples/kpsetime.rs (line 8)

fn main() {
    let t = std::time::Instant::now();
    let mut o = Options::lualatex();
    o.cache_dir = Some(std::env::temp_dir().join("retex-kpse-test"));
    let mut k = Kpathsea::new(o).unwrap();
    let init = t.elapsed();
    let t = std::time::Instant::now();
    for n in [
        "latex.ltx",
        "article.cls",
        "size10.clo",
        "lmroman10-regular.otf",
        "ltluatex.lua",
    ] {
        let f = if n.ends_with(".otf") {
            FileFormat::OpenType
        } else if n.ends_with(".lua") {
            FileFormat::Lua
        } else {
            FileFormat::Tex
        };
        let _ = k.find_file(n, f);
    }
    println!("init {init:?}, 5 lookups {:?}", t.elapsed());
}

pub fn with_env(options: Options, env: Box<dyn Env>) -> Result<Self, Error>

Initializes kpathsea with a custom environment.

pub fn progname(&self) -> &str

The program name.

pub fn engine(&self) -> &str

The engine name.

pub fn cache_dir(&self) -> Option<&Path>

The directory of retex’s cache files, if any.

pub fn installed_names(&self, suffix: &str) -> Vec<String>

The names of the files ending with suffix in the ls-R databases (each once, sorted): what is installed, for suggestions.

pub fn var_value(&self, name: &str) -> Option<String>

Returns the expanded value of variable name, like kpsewhich -var-value. Braces are not expanded.

pub fn search_path(&mut self, format: FileFormat) -> &[String]

The fully expanded search path for format, one element per entry. Elements may start with !! and contain //.

Examples found in repository

examples/kpsewhich.rs (line 16)

fn main() {
    let args: Vec<String> = std::env::args().collect();
    let fmt = match args.get(1).map(String::as_str) {
        Some("lua") => FileFormat::Lua,
        Some("fmt") => FileFormat::Fmt,
        Some("otf") => FileFormat::OpenType,
        Some("tfm") => FileFormat::Tfm,
        _ => FileFormat::Tex,
    };
    let mut k = Kpathsea::new(Options::lualatex()).unwrap();
    let t = std::time::Instant::now();
    let found = k.find_file(&args[2], fmt);
    eprintln!("path: {:?}", k.search_path(fmt));
    println!("{found:?} ({:?})", t.elapsed());
}

pub fn find_file(&mut self, name: &str, format: FileFormat) -> Option<PathBuf>

Finds the first file matching name in the search path of format, like kpsewhich -format=… name.

Examples found in repository

examples/kpsewhich.rs (line 15)

fn main() {
    let args: Vec<String> = std::env::args().collect();
    let fmt = match args.get(1).map(String::as_str) {
        Some("lua") => FileFormat::Lua,
        Some("fmt") => FileFormat::Fmt,
        Some("otf") => FileFormat::OpenType,
        Some("tfm") => FileFormat::Tfm,
        _ => FileFormat::Tex,
    };
    let mut k = Kpathsea::new(Options::lualatex()).unwrap();
    let t = std::time::Instant::now();
    let found = k.find_file(&args[2], fmt);
    eprintln!("path: {:?}", k.search_path(fmt));
    println!("{found:?} ({:?})", t.elapsed());
}

examples/kpsetime.rs (line 25)

fn main() {
    let t = std::time::Instant::now();
    let mut o = Options::lualatex();
    o.cache_dir = Some(std::env::temp_dir().join("retex-kpse-test"));
    let mut k = Kpathsea::new(o).unwrap();
    let init = t.elapsed();
    let t = std::time::Instant::now();
    for n in [
        "latex.ltx",
        "article.cls",
        "size10.clo",
        "lmroman10-regular.otf",
        "ltluatex.lua",
    ] {
        let f = if n.ends_with(".otf") {
            FileFormat::OpenType
        } else if n.ends_with(".lua") {
            FileFormat::Lua
        } else {
            FileFormat::Tex
        };
        let _ = k.find_file(n, f);
    }
    println!("init {init:?}, 5 lookups {:?}", t.elapsed());
}

Trait Implementations

impl Debug for Kpathsea

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

Formats the value using the given formatter.