Struct grep_printer::HyperlinkEnvironment

pub struct HyperlinkEnvironment { /* private fields */ }

A static environment for hyperlink interpolation.

This environment permits setting the values of variables used in hyperlink interpolation that are not expected to change for the lifetime of a program. That is, these values are invariant.

Currently, this includes the hostname and a WSL distro prefix.

Implementations

impl HyperlinkEnvironment

pub fn new() -> HyperlinkEnvironment

Create a new empty hyperlink environment.

pub fn host(&mut self, host: Option<String>) -> &mut HyperlinkEnvironment

Set the {host} variable, which fills in any hostname components of a hyperlink.

One can get the hostname in the current environment via the hostname function in the grep-cli crate.

pub fn wsl_prefix( &mut self, wsl_prefix: Option<String>, ) -> &mut HyperlinkEnvironment

Set the {wslprefix} variable, which contains the WSL distro prefix. An example value is wsl$/Ubuntu. The distro name can typically be discovered from the WSL_DISTRO_NAME environment variable.

Trait Implementations

impl Clone for HyperlinkEnvironment

fn clone(&self) -> HyperlinkEnvironment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyperlinkEnvironment

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

Formats the value using the given formatter.

impl Default for HyperlinkEnvironment

fn default() -> HyperlinkEnvironment

Returns the “default value” for a type.

impl PartialEq for HyperlinkEnvironment

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HyperlinkEnvironment

impl StructuralPartialEq for HyperlinkEnvironment