Struct tectonic::io::filesystem::FilesystemIo

pub struct FilesystemIo { /* fields omitted */ }

FilesystemIo is an I/O provider that reads, and optionally writes, files from a given root directory. NOTE: no effort is made to contain I/O within the specified root!! We have an option to disallow absolute paths, but we don't do anything about "../../../...." paths.

Implementations

impl FilesystemIo

pub fn new(
    root: &Path,
    writes_allowed: bool,
    absolute_allowed: bool,
    hidden_input_paths: HashSet<PathBuf>
) -> FilesystemIo

Trait Implementations

impl IoProvider for FilesystemIo

fn output_open_name(&mut self, name: &OsStr) -> OpenResult<OutputHandle>

fn output_open_stdout(&mut self) -> OpenResult<OutputHandle>

fn input_open_name(
    &mut self,
    name: &OsStr,
    _status: &mut dyn StatusBackend
) -> OpenResult<InputHandle>

fn input_open_primary(
    &mut self,
    _status: &mut dyn StatusBackend
) -> OpenResult<InputHandle>

Open the "primary" input file, which in the context of TeX is the main input that it's given. When the build is being done using the filesystem and the input is a file on the filesystem, this function isn't necesssarily that important, but those conditions don't always hold.

fn input_open_format(
    &mut self,
    name: &OsStr,
    status: &mut dyn StatusBackend
) -> OpenResult<InputHandle>

Open a format file with the specified name. Format files have a specialized entry point because IOProviders may wish to handle them specially: namely, to munge the filename to one that includes the current version of the Tectonic engine, since the format contents depend sensitively on the engine internals.

fn write_format(
    &mut self,
    _name: &str,
    _data: &[u8],
    _status: &mut dyn StatusBackend
) -> Result<()>

Save an a format dump in some way that this provider may be able to recover in the future. This awkward interface is needed for to write formats with their special munged file names.