Struct grep_cli::DecompressionReader [−][src]
pub struct DecompressionReader { /* fields omitted */ }
Expand description
A streaming reader for decompressing the contents of a file.
The purpose of this reader is to provide a seamless way to decompress the
contents of file using existing tools in the current environment. This is
meant to be an alternative to using decompression libraries in favor of the
simplicity and portability of using external commands such as gzip
and
xz
. This does impose the overhead of spawning a process, so other means
for performing decompression should be sought if this overhead isn’t
acceptable.
A decompression reader comes with a default set of matching rules that are
meant to associate file paths with the corresponding command to use to
decompress them. For example, a glob like *.gz
matches gzip compressed
files with the command gzip -d -c
. If a file path does not match any
existing rules, or if it matches a rule whose command does not exist in the
current environment, then the decompression reader passes through the
contents of the underlying file without doing any decompression.
The default matching rules are probably good enough for most cases, and if
they require revision, pull requests are welcome. In cases where they must
be changed or extended, they can be customized through the use of
DecompressionMatcherBuilder
and
DecompressionReaderBuilder
.
By default, this reader will asynchronously read the processes’ stderr. This prevents subtle deadlocking bugs for noisy processes that write a lot to stderr. Currently, the entire contents of stderr is read on to the heap.
Example
This example shows how to read the decompressed contents of a file without needing to explicitly choose the decompression command to run.
Note that if you need to decompress multiple files, it is better to use
DecompressionReaderBuilder
, which will amortize the cost of compiling the
matcher.
use std::io::Read; use std::process::Command; use grep_cli::DecompressionReader; let mut rdr = DecompressionReader::new("/usr/share/man/man1/ls.1.gz")?; let mut contents = vec![]; rdr.read_to_end(&mut contents)?;
Implementations
Build a new streaming reader for decompressing data.
If decompression is done out-of-process and if there was a problem spawning the process, then its error is returned.
If the given file path could not be matched with a decompression strategy, then a passthru reader is returned that does no decompression.
This uses the default matching rules for determining how to decompress
the given file. To change those matching rules, use
DecompressionReaderBuilder
and
DecompressionMatcherBuilder
.
When creating readers for many paths. it is better to use the builder since it will amortize the cost of constructing the matcher.
Closes this reader, freeing any resources used by its underlying child process, if one was used. If the child process exits with a nonzero exit code, the returned Err value will include its stderr.
close
is idempotent, meaning it can be safely called multiple times.
The first call closes the CommandReader and any subsequent calls do
nothing.
This method should be called after partially reading a file to prevent
resource leakage. However there is no need to call close
explicitly
if your code always calls read
to EOF, as read
takes care of
calling close
in this case.
close
is also called in drop
as a last line of defense against
resource leakage. Any error from the child process is then printed as a
warning to stderr. This can be avoided by explictly calling close
before the CommandReader is dropped.
Trait Implementations
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
Like read
, except that it reads into a slice of buffers. Read more
can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
read_initializer
)Determines if this Read
er can work with buffers of uninitialized
memory. Read more
Read all bytes until EOF in this source, placing them into buf
. Read more
Read all bytes until EOF in this source, appending them to buf
. Read more
Read the exact number of bytes required to fill buf
. Read more
Creates a “by reference” adaptor for this instance of Read
. Read more
Creates an adaptor which will chain this stream with another. Read more
Auto Trait Implementations
impl !RefUnwindSafe for DecompressionReader
impl Send for DecompressionReader
impl Sync for DecompressionReader
impl Unpin for DecompressionReader
impl !UnwindSafe for DecompressionReader