Struct tectonic::io::stdstreams::BufferedPrimaryIo

pub struct BufferedPrimaryIo { /* fields omitted */ }

BufferedPrimaryIo provides a mechanism for the TeX "primary input" to come from stdin. Because Tectonic makes multiple passes through the input by default, we have to buffer it in memory so that the input can be read multiple times. It wouldn't be hard to make an alternative implementation that skips the buffering and errors out if one tries to open the stream more than once.

TODO: it might be better to stream stdin to a temporary file on disk that we then delete while holding on to the file handle. But mkstemp-rs doesn't give us Files and the whole approach might get a bit hairy, so we don't do that.

TODO: it also would be nicer to actually stream through stdin at pace on the first pass rather than slurping it all into memory upon construction, but once more we're being lazy.

Implementations

impl BufferedPrimaryIo

pub fn from_stream<T: Read>(stream: &mut T) -> Result<Self>

Create a new primary-I/O buffer from a type implementing Read.

The stream will be read and buffered in memory — regardless of how large it is. This approach is required because Tectonic will generally need to make multiple passes over the input file.

pub fn from_stdin() -> Result<Self>

Create a new primary-I/O buffer from this processes's standard input.

Standard input will be read and buffered in memory — regardless of how large it is. This approach is required because Tectonic will generally need to make multiple passes over the input file.

pub fn from_text<T: AsRef<str>>(text: T) -> Self

Create a new primary-I/O buffer from a string.

The string is converted into bytes as per [str.as_bytes].

pub fn from_buffer(buf: Vec<u8>) -> Self

Create a new primary-I/O buffer from a byte vector.

Trait Implementations

impl Clone for BufferedPrimaryIo

fn clone(&self) -> BufferedPrimaryIo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BufferedPrimaryIo

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

Formats the value using the given formatter.

impl Eq for BufferedPrimaryIo

impl IoProvider for BufferedPrimaryIo

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

impl PartialEq<BufferedPrimaryIo> for BufferedPrimaryIo

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for BufferedPrimaryIo

impl StructuralPartialEq for BufferedPrimaryIo