Struct mdcat::Environment

pub struct Environment {
    pub base_url: Url,
    pub hostname: String,
}

The environment to render markdown in.

Fields

base_url: Url

The base URL to resolve relative URLs with.

hostname: String

The local host name.

Implementations

impl Environment

pub fn for_localhost(base_url: Url) -> Result<Self>

Create an environment for the local host with the given base_url.

Take the local hostname from gethostname.

pub fn for_local_directory<P: AsRef<Path>>(base_dir: &P) -> Result<Self>

Create an environment for a local diretory.

Convert the directory to a directory URL, and obtain the hostname from gethostname.

base_dir must be an absolute path; return an IO error with ErrorKind::InvalidInput otherwise.

Trait Implementations

impl Debug for Environment

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

Formats the value using the given formatter.