Struct MockUrl 

pub struct MockUrl {
    pub url_representation: String,
    pub slashable: bool,
    pub base_url_representation: Option<String>,
    pub query: Option<UrlQuery>,
    pub fragment: Option<String>,
    pub format: Option<String>,
    pub content: Option<ReadableBuffer>,
    /* private fields */
}

A standalone URL implementation intended for testing purposes.

You can set a URL representation as you please, mocking any other scheme or not following the URL notation at all. Thus mock URLs must be explictly created via UrlContext::mock_url and cannot be returned by general UrlContext functions.

The URL::base and URL::relative functions are supported in two modes. When slashable is true, they will interpret the URL representation 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 provide a base_url_representation if you want to support URL::base. For both functions, the content and format are simply cloned.

URL::conform does nothing.

For custom URLs that are supported by general UrlContext functions, see InternalUrl.

Fields

url_representation: String

The URL representation.

slashable: bool

Whether the URL representation is “slashable”.

base_url_representation: Option<String>

The optional base URL representation (used when slashable is false).

query: Option<UrlQuery>

The optional query.

fragment: Option<String>

The optional fragment.

format: Option<String>

The optional format.

content: Option<ReadableBuffer>

The optional content.

Implementations

impl MockUrl

pub fn new( context: &UrlContextRef, url_representation: String, slashable: bool, base_url_representation: Option<String>, query: Option<UrlQuery>, fragment: Option<String>, format: Option<String>, content: Option<&[u8]>, ) -> Self

Constructor.

pub fn new_with(&self, url_representation: String) -> MockUrl

Constructor.

Trait Implementations

impl Clone for MockUrl

fn clone(&self) -> MockUrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MockUrl

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

Formats the value using the given formatter.

impl Display for MockUrl

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

Formats the value using the given formatter.

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

fn into(self) -> UrlRef

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

impl URL for MockUrl

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.