Struct vimwiki::vendor::uriparse::uri_reference::URIReference[]

pub struct URIReference<'uri> { /* fields omitted */ }
Expand description

A URI reference as defined in [RFC3986, Section 4.1].

Specifically, a URI reference is either a URI or a relative reference (a schemeless URI).

Implementations

Returns the authority, if present, of the URI reference.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("//example.com/my/path").unwrap();
assert_eq!(reference.authority().unwrap().to_string(), "example.com");

Constructs a default builder for a URI reference.

This provides an alternative means of constructing a URI reference besides parsing and URIReference::from_parts.

Examples

use std::convert::TryFrom;

use uriparse::{Authority, Path, Scheme, URIReference};

let reference = URIReference::builder()
    .with_scheme(Some(Scheme::HTTP))
    .with_authority(Some(Authority::try_from("example.com").unwrap()))
    .with_path(Path::try_from("/my/path").unwrap())
    .build()
    .unwrap();
assert_eq!(reference.to_string(), "http://example.com/my/path");

Returns whether the URI reference can act as a base URI.

A URI can be a base if it is absolute (i.e. it has no fragment component).

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://example.com/my/path").unwrap();
assert!(reference.can_be_a_base());

let reference = URIReference::try_from("ftp://127.0.0.1#fragment").unwrap();
assert!(!reference.can_be_a_base());

Constructs a new URIReference from the individual parts: scheme, authority, path, query, and fragment.

The lifetime used by the resulting value will be the lifetime of the part that is most restricted in scope.

Examples

use std::convert::TryFrom;

use uriparse::{Scheme, URIReference};

let reference = URIReference::from_parts(
    None::<Scheme>,
    Some("example.com"),
    "/my/path",
    Some("query"),
    Some("fragment")
).unwrap();
assert_eq!(reference.to_string(), "//example.com/my/path?query#fragment");

Returns the fragment, if present, of the URI reference.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://example.com#fragment").unwrap();
assert_eq!(reference.fragment().unwrap(), "fragment");

Returns whether the URI reference has an authority component.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://example.com").unwrap();
assert!(reference.has_authority());

let reference = URIReference::try_from("").unwrap();
assert!(!reference.has_authority());

Returns whether the URI reference has a fragment component.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("#test").unwrap();
assert!(reference.has_fragment());

let reference = URIReference::try_from("http://example.com").unwrap();
assert!(!reference.has_fragment());

Returns whether the URI reference has a password component.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://user:pass@127.0.0.1").unwrap();
assert!(reference.has_password());

let reference = URIReference::try_from("http://user@127.0.0.1").unwrap();
assert!(!reference.has_password());

Returns whether the URI reference has a port.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://127.0.0.1:8080").unwrap();
assert!(reference.has_port());

let reference = URIReference::try_from("http://127.0.0.1").unwrap();
assert!(!reference.has_port());

Returns whether the URI reference has a query component.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("/?my=query").unwrap();
assert!(reference.has_query());

let reference = URIReference::try_from("http://example.com/my/path").unwrap();
assert!(!reference.has_query());

Returns whether the URI reference has a scheme component.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://example.com?my=query").unwrap();
assert!(reference.has_scheme());

let reference = URIReference::try_from("/my/path").unwrap();
assert!(!reference.has_scheme());

Returns whether the URI reference has a username component.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("//username@example.com").unwrap();
assert!(reference.has_username());

let reference = URIReference::try_from("http://example.com").unwrap();
assert!(!reference.has_username());

Returns the host, if present, of the URI reference.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://username@example.com").unwrap();
assert_eq!(reference.host().unwrap().to_string(), "example.com");

Consumes the URI reference and converts it into a builder with the same values.

Examples

use std::convert::TryFrom;

use uriparse::{Fragment, Query, URIReference};

let reference = URIReference::try_from("//example.com/path?query#fragment").unwrap();
let mut builder = reference.into_builder();
builder.query(None::<Query>).fragment(None::<Fragment>);
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "//example.com/path");

Converts the URIReference into an owned copy.

If you construct the URI reference from a source with a non-static lifetime, you may run into lifetime problems due to the way the struct is designed. Calling this function will ensure that the returned value has a static lifetime.

This is different from just cloning. Cloning the URI reference will just copy the references, and thus the lifetime will remain the same.

Consumes the URIReference and returns its parts: scheme, authority, path, query, and fragment.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from(
    "http://username:password@example.com:80/my/path?my=query#fragment",
).unwrap();
let (scheme, authority, path, query, fragment) = reference.into_parts();

assert_eq!(scheme.unwrap(), "http");
assert_eq!(authority.unwrap().to_string(), "username:password@example.com:80");
assert_eq!(path, "/my/path");
assert_eq!(query.unwrap(), "my=query");
assert_eq!(fragment.unwrap(), "fragment");

Returns whether the URI reference is an absolute path reference.

A URI reference is an absolute path reference if it is a relative reference that begins with a single '/'.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("/my/path").unwrap();
assert!(reference.is_absolute_path_reference());

Returns whether the URI reference is a network path reference.

A URI reference is a network path reference if it is a relative reference that begins with two '/'.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("//example.com").unwrap();
assert!(reference.is_network_path_reference());

Returns whether the URI reference is normalized.

A normalized URI reference will have all of its components normalized.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://example.com/?a=b").unwrap();
assert!(reference.is_normalized());

let mut reference = URIReference::try_from("http://EXAMPLE.com/?a=b").unwrap();
assert!(!reference.is_normalized());
reference.normalize();
assert!(reference.is_normalized());

Returns whether the URI reference is a relative path reference.

A URI reference is a relative path reference if it is a relative reference that does not begin with a '/'.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("my/path").unwrap();
assert!(reference.is_relative_path_reference());

Returns whether the URI reference is a relative reference.

A URI reference is a relative reference if it has no scheme.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("/my/path").unwrap();
assert!(reference.is_relative_reference());

Returns whether the URI reference is a URI.

A URI reference is a URI if it has a scheme.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://example.com").unwrap();
assert!(reference.is_uri());

Maps the authority using the given map function.

This function will panic if, as a result of the authority change, the URI reference becomes invalid.

Examples

use std::convert::TryFrom;

use uriparse::{Authority, URIReference};

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.map_authority(|_| Some(Authority::try_from("127.0.0.1").unwrap()));
assert_eq!(reference.to_string(), "http://127.0.0.1/");

Maps the fragment using the given map function.

Examples

use std::convert::TryFrom;

use uriparse::{Fragment, URIReference};

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.map_fragment(|_| Some(Fragment::try_from("fragment").unwrap()));
assert_eq!(reference.to_string(), "http://example.com/#fragment");

Maps the path using the given map function.

This function will panic if, as a result of the path change, the URI reference becomes invalid.

Examples

use std::convert::TryFrom;

use uriparse::{Authority, URIReference};

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.map_path(|mut path| {
    path.push("test").unwrap();
    path.push("path").unwrap();
    path
});
assert_eq!(reference.to_string(), "http://example.com/test/path");

Maps the query using the given map function.

Examples

use std::convert::TryFrom;

use uriparse::{Query, URIReference};

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.map_query(|_| Some(Query::try_from("query").unwrap()));
assert_eq!(reference.to_string(), "http://example.com/?query");

Maps the scheme using the given map function.

This function will panic if, as a result of the scheme change, the URI reference becomes invalid.

Examples

use std::convert::TryFrom;

use uriparse::{Scheme, URIReference};

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.map_scheme(|_| Some(Scheme::try_from("https").unwrap()));
assert_eq!(reference.to_string(), "https://example.com/");

Normalizes the URI reference.

A normalized URI reference will have all of its components normalized.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let mut reference = URIReference::try_from("http://example.com/?a=b").unwrap();
reference.normalize();
assert_eq!(reference.to_string(), "http://example.com/?a=b");

let mut reference = URIReference::try_from("http://EXAMPLE.com/?a=b").unwrap();
assert_eq!(reference.to_string(), "http://EXAMPLE.com/?a=b");
reference.normalize();
assert_eq!(reference.to_string(), "http://example.com/?a=b");

Returns the path of the URI reference.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://127.0.0.1/my/path").unwrap();
assert_eq!(reference.path(), "/my/path");

Returns the password, if present, of the URI reference.

Usage of a password in URI and URI references is deprecated.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://user:pass@example.com").unwrap();
assert_eq!(reference.password().unwrap(), "pass");

Returns the port, if present, of the URI reference.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://example.com:8080/").unwrap();
assert_eq!(reference.port().unwrap(), 8080);

Returns the query, if present, of the URI reference.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://127.0.0.1?my=query").unwrap();
assert_eq!(reference.query().unwrap(), "my=query");

Returns the scheme, if present, of the URI reference.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://127.0.0.1/").unwrap();
assert_eq!(reference.scheme().unwrap(), "http");

Sets the authority of the URI reference.

An error will be returned if the conversion to an Authority fails.

The existing path will be set to absolute (i.e. starts with a '/').

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.set_authority(Some("user@example.com:80"));
assert_eq!(reference.to_string(), "http://user@example.com:80/");

Sets the fragment of the URI reference.

An error will be returned if the conversion to a Fragment fails.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.set_fragment(Some("fragment"));
assert_eq!(reference.to_string(), "http://example.com/#fragment");

Sets the path of the URI reference.

An error will be returned in one of two cases:

  • The conversion to Path failed.
  • The path was set to a value that resulted in an invalid URI reference.

Regardless of whether the given path was set as absolute or relative, if the URI reference currently has an authority, the path will be forced to be absolute.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.set_path("my/path");
assert_eq!(reference.to_string(), "http://example.com/my/path");

Sets the query of the URI reference.

An error will be returned if the conversion to a Query fails.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.set_query(Some("myquery"));
assert_eq!(reference.to_string(), "http://example.com/?myquery");

Sets the scheme of the URI reference.

An error will be returned in one of two cases:

  • The conversion to Scheme failed.
  • The scheme was set to None, but the resulting URI reference has an invalid schemeless path.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let mut reference = URIReference::try_from("http://example.com").unwrap();
reference.set_scheme(Some("https"));
assert_eq!(reference.to_string(), "https://example.com/");

Returns the username, if present, of the URI reference.

Examples

use std::convert::TryFrom;

use uriparse::URIReference;

let reference = URIReference::try_from("http://username@example.com").unwrap();
assert_eq!(reference.username().unwrap(), "username");

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Deserialize this value from the given Serde deserializer. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

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

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Converts self into T using Into<T>. Read more

Converts self into a target type. Read more

Causes self to use its Binary implementation when Debug-formatted.

Causes self to use its Display implementation when Debug-formatted. Read more

Causes self to use its LowerExp implementation when Debug-formatted. Read more

Causes self to use its LowerHex implementation when Debug-formatted. Read more

Causes self to use its Octal implementation when Debug-formatted.

Causes self to use its Pointer implementation when Debug-formatted. Read more

Causes self to use its UpperExp implementation when Debug-formatted. Read more

Causes self to use its UpperHex implementation when Debug-formatted. Read more

Performs the conversion.

Performs the conversion.

Pipes by value. This is generally the method you want to use. Read more

Borrows self and passes that borrow into the pipe function. Read more

Mutably borrows self and passes that borrow into the pipe function. Read more

Borrows self, then passes self.borrow() into the pipe function. Read more

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

Borrows self, then passes self.as_ref() into the pipe function.

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

Borrows self, then passes self.deref() into the pipe function.

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

Pipes a value into a function that cannot ordinarily be called in suffix position. Read more

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

Pipes a dereference into a function that cannot normally be called in suffix position. Read more

Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more

Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more

Pipes a mutable reference into a function that cannot ordinarily be called in suffix position. Read more

Immutable access to a value. Read more

Mutable access to a value. Read more

Immutable access to the Borrow<B> of a value. Read more

Mutable access to the BorrowMut<B> of a value. Read more

Immutable access to the AsRef<R> view of a value. Read more

Mutable access to the AsMut<R> view of a value. Read more

Immutable access to the Deref::Target of a value. Read more

Mutable access to the Deref::Target of a value. Read more

Calls .tap() only in debug builds, and is erased in release builds.

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

Provides immutable access for inspection. Read more

Calls tap in debug builds, and does nothing in release builds.

Provides mutable access for modification. Read more

Calls tap_mut in debug builds, and does nothing in release builds.

Provides immutable access to the reference for inspection.

Calls tap_ref in debug builds, and does nothing in release builds.

Provides mutable access to the reference for modification.

Calls tap_ref_mut in debug builds, and does nothing in release builds.

Provides immutable access to the borrow for inspection. Read more

Calls tap_borrow in debug builds, and does nothing in release builds.

Provides mutable access to the borrow for modification.

Calls tap_borrow_mut in debug builds, and does nothing in release builds. Read more

Immutably dereferences self for inspection.

Calls tap_deref in debug builds, and does nothing in release builds.

Mutably dereferences self for modification.

Calls tap_deref_mut in debug builds, and does nothing in release builds. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

Attempts to convert self into T using TryInto<T>. Read more

Attempts to convert self into a target type. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.