Struct grep_printer::PrinterPath

pub struct PrinterPath<'a>(_);

A simple encapsulation of a file path used by a printer.

This represents any transforms that we might want to perform on the path, such as converting it to valid UTF-8 and/or replacing its separator with something else. This allows us to amortize work if we are printing the file path for every match.

In the common case, no transformation is needed, which lets us avoid the allocation. Typically, only Windows requires a transform, since we can't access the raw bytes of a path directly and first need to lossily convert to UTF-8. Windows is also typically where the path separator replacement is used, e.g., in cygwin environments to use / instead of \.

Users of this type are expected to construct it from a normal Path found in the standard library. It can then be written to any io::Write implementation using the as_bytes method. This achieves platform portability with a small cost: on Windows, paths that are not valid UTF-16 will not roundtrip correctly.

Methods

impl<'a> PrinterPath<'a>

pub fn new(path: &'a Path) -> PrinterPath<'a>

Create a new path suitable for printing.

pub fn with_separator(path: &'a Path, sep: Option<u8>) -> PrinterPath<'a>

Create a new printer path from the given path which can be efficiently written to a writer without allocation.

If the given separator is present, then any separators in path are replaced with it.

pub fn as_bytes(&self) -> &[u8]

Return the raw bytes for this path.

Trait Implementations

impl<'a> Clone for PrinterPath<'a>

fn clone(&self) -> PrinterPath<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PrinterPath<'a>

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

Formats the value using the given formatter.