pub struct HyperlinkEnvironment { /* private fields */ }
Expand description

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§

source§

impl HyperlinkEnvironment

source

pub fn new() -> HyperlinkEnvironment

Create a new empty hyperlink environment.

source

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.

source

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§

source§

impl Clone for HyperlinkEnvironment

source§

fn clone(&self) -> HyperlinkEnvironment

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for HyperlinkEnvironment

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for HyperlinkEnvironment

source§

fn default() -> HyperlinkEnvironment

Returns the “default value” for a type. Read more
source§

impl PartialEq<HyperlinkEnvironment> for HyperlinkEnvironment

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for HyperlinkEnvironment

source§

impl StructuralEq for HyperlinkEnvironment

source§

impl StructuralPartialEq for HyperlinkEnvironment

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.