Struct FileUrl 

pub struct FileUrl {
    pub path: PathBuf,
    pub host: Option<String>,
    pub query: Option<UrlQuery>,
    pub fragment: Option<String>,
    /* private fields */
}

Available on crate feature file only.

A URL for a file or a directory that is locally accessible.

The URL scheme is “file:”.

A conforming file URL will have a canonical path (no “.” or “..” segments). If it’s a directory then it will end in a path separator.

The path notation depends on the operating system on which this library is compiled. For example, on Unix-like operating systems the path separator would be “/” and the root would start with “/”, while on Windows the path separator would be “" and the root would start with the drive name and “:", e.g. “C:".

However, note that the URL notation is standardized differently. Only “/” is used as a path separator and for the root. Thus, on Windows “" becomes a “/”. Preceding the path is “//” plus a host. Because the host is rarely used, file URLs most often start with “file:///”.

For example, on Windows the path “C:\Windows\win.ini” would have the URL “file:///C:/Windows/win.ini”.

This library supports the host for presentation purposes, but it is not used for URL::open.

Fields

path: PathBuf

The PathBuf.

host: Option<String>

The optional host (for representation purposes only).

query: Option<UrlQuery>

The optional query.

fragment: Option<String>

The optional fragment.

Implementations

impl FileUrl

pub fn new( context: &UrlContextRef, path: PathBuf, host: Option<String>, query: Option<UrlQuery>, fragment: Option<String>, ) -> Self

Constructor.

pub fn new_with(&self, path: PathBuf) -> Self

Constructor.

Trait Implementations

impl Clone for FileUrl

fn clone(&self) -> FileUrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileUrl

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

Formats the value using the given formatter.

impl Display for FileUrl

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

Formats the value using the given formatter.

impl Into<Box<dyn URL + Send + Sync>> for FileUrl

fn into(self) -> UrlRef

Converts this type into the (usually inferred) input type.

impl URL for FileUrl

fn context(&self) -> &UrlContext

The UrlContext used to create this URL.

fn query(&self) -> Option<UrlQuery>

The optional query.

fn fragment(&self) -> Option<String>

The optional fragment.

fn format(&self) -> Option<String>

Format of the URL content’s canonical representation.

fn local(&self) -> Option<PathBuf>

If this URL points to a local path, returns it.

fn base(&self) -> Option<UrlRef>

Returns a URL that is the equivalent of a “base directory” for the URL.

fn relative(&self, path: &str) -> UrlRef

Parses the argument as a path relative to the URL. That means that this URL is treated as a “base directory” (see base). The argument supports “..” and “.”, with the returned URL path always being absolute.

fn conform(&mut self) -> Result<(), UrlError>

Available on crate feature blocking only.

Ensures that the URL conforms with the expectations of its functions. If successful, this function may change the URL appropriately, e.g. a relative path would be turned into an absolute path.

fn conform_async(&self) -> Result<ConformFuture, UrlError>

Available on crate feature async only.

Async version of URL::conform.

fn open(&self) -> Result<ReadRef, UrlError>

Available on crate feature blocking only.

Opens the URL for reading by providing a dyn Read.

fn open_async(&self) -> Result<OpenFuture, UrlError>

Available on crate feature async only.

Async version of URL::open. Provides a dyn AsyncRead.

fn key(&self) -> String

Returns a string that uniquely identifies the URL.