[−][src]Struct grep_cli::DecompressionReader
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)?;
Methods
impl DecompressionReader
[src]
pub fn new<P: AsRef<Path>>(path: P) -> Result<DecompressionReader, CommandError>
[src]
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.
Trait Implementations
impl Debug for DecompressionReader
[src]
impl Read for DecompressionReader
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>
1.36.0[src]
Like read
, except that it reads into a slice of buffers. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Creates an adaptor which will read at most limit
bytes from it. Read more
Auto Trait Implementations
impl Send for DecompressionReader
impl Unpin for DecompressionReader
impl Sync for DecompressionReader
impl !UnwindSafe for DecompressionReader
impl !RefUnwindSafe for DecompressionReader
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,