Struct grep_printer::HyperlinkFormat

pub struct HyperlinkFormat { /* private fields */ }

A hyperlink format with variables.

This can be created by parsing a string using HyperlinkFormat::from_str.

The default format is empty. An empty format is valid and effectively disables hyperlinks.

Example

use grep_printer::HyperlinkFormat;

let fmt = "vscode".parse::<HyperlinkFormat>()?;
assert_eq!(fmt.to_string(), "vscode://file{path}:{line}:{column}");

Implementations

impl HyperlinkFormat

pub fn empty() -> HyperlinkFormat

Creates an empty hyperlink format.

pub fn is_empty(&self) -> bool

Returns true if this format is empty.

pub fn into_config(self, env: HyperlinkEnvironment) -> HyperlinkConfig

Creates a HyperlinkConfig from this format and the environment given.

Trait Implementations

impl Clone for HyperlinkFormat

fn clone(&self) -> HyperlinkFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyperlinkFormat

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

Formats the value using the given formatter.

impl Default for HyperlinkFormat

fn default() -> HyperlinkFormat

Returns the “default value” for a type.

impl Display for HyperlinkFormat

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

Formats the value using the given formatter.

impl FromStr for HyperlinkFormat

type Err = HyperlinkFormatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<HyperlinkFormat, HyperlinkFormatError>

Parses a string s to return a value of this type.

impl PartialEq<HyperlinkFormat> for HyperlinkFormat

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

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

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.

impl Eq for HyperlinkFormat

impl StructuralEq for HyperlinkFormat

impl StructuralPartialEq for HyperlinkFormat