Struct InternalUrl 

pub struct InternalUrl {
    pub path: String,
    pub metadata: InternalUrlMetadata,
    pub host: Option<String>,
    pub query: Option<UrlQuery>,
    pub fragment: Option<String>,
    /* private fields */
}

An internal URL.

The URL scheme is “internal:”, followed by a custom path representation.

The URL::base and URL::relative functions are supported in two modes. When slashable is true, they will interpret the path as a Unix-style filesystem path, whereby the path separator is “/”, and “.” and “..” are supported for path traversal. When slashable is false, URL::relative does simple string concatenation, and you must explicitly register a base_path if you want to support URL::base.

URL::conform is critical for internal URLs: it makes sure to fill in metadata from the registry.

If your use case is testing, it could be that MockUrl would be easier to use, as it is not owned by UrlContext and can mock any scheme.

Fields

path: String

The path.

metadata: InternalUrlMetadata

Metadata.

host: Option<String>

The optional host (for representation purposes only).

query: Option<UrlQuery>

The optional query.

fragment: Option<String>

The optional fragment.

Implementations

impl InternalUrl

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

Constructor.

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

Constructor.

Trait Implementations

impl Clone for InternalUrl

fn clone(&self) -> InternalUrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InternalUrl

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

Formats the value using the given formatter.

impl Display for InternalUrl

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

Formats the value using the given formatter.

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

fn into(self) -> UrlRef

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

impl URL for InternalUrl

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 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.

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

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