Struct Url 

pub struct Url(/* private fields */);

An OCPI URL.

The text is stored exactly as received. A URL is an identifier as much as a location: a peer that registered https://example.com/ocpi/cpo/2.3.0 must see that string again, not the https://example.com/ocpi/cpo/2.3.0 that a normalising parser would hand back with a re-encoded path or an added trailing slash. Url::parse gives the parsed form when it is needed for making a request.

use ocpi_kit::types::Url;

let url = Url::new("https://example.com/ocpi/cpo/2.3.0/locations").unwrap();
assert_eq!(url.as_str(), "https://example.com/ocpi/cpo/2.3.0/locations");
assert_eq!(url.parse().unwrap().host_str(), Some("example.com"));

Spec: 2.3.0 §types_url_type

Implementations

impl Url

pub fn new(value: impl Into<String>) -> Result<Self, InvalidUrl>

Creates a Url, checking that it parses as an absolute URL and fits string(255).

Errors

Returns InvalidUrl if the text is not an absolute URL or is longer than 255 characters.

pub fn new_lenient(value: impl Into<String>) -> Self

Creates a Url without checking anything. Used by Deserialize.

pub fn as_str(&self) -> &str

The URL exactly as received or constructed.

pub fn into_string(self) -> String

Consumes this value and yields the inner text.

pub fn parse(&self) -> Result<Url, InvalidUrl>

Parses the URL.

Errors

Returns InvalidUrl if the stored text is not a URL. This can only happen for values that came off the wire, since Url::new checks up front.

pub fn join(&self, segment: &str) -> Self

This URL with a path segment appended, keeping exactly one / between the two.

Endpoint URLs discovered from a peer sometimes carry a trailing slash and sometimes do not; this joins correctly either way and never emits a double slash or a trailing one.

use ocpi_kit::types::Url;
let base = Url::new("https://example.com/ocpi/cpo/2.3.0/locations/").unwrap();
assert_eq!(base.join("NL").join("TNM").as_str(),
           "https://example.com/ocpi/cpo/2.3.0/locations/NL/TNM");

pub fn with_query(&self, query: &str) -> Self

This URL with a query string appended, using ? or & as appropriate.

pub fn check(&self, policy: &UrlPolicy) -> Result<(), UrlRefused>

Whether this URL is acceptable under policy.

Errors

Returns the reason the URL was refused.

Trait Implementations

impl AsRef<str> for Url

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Url

fn clone(&self) -> Url

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Url

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

Formats the value using the given formatter.

impl Default for Url

fn default() -> Url

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Url

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Url

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

Formats the value using the given formatter.

impl Eq for Url

impl From<&str> for Url

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Url

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Url> for Url

fn from(value: Url) -> Self

Converts to this type from the input type.

impl FromStr for Url

type Err = InvalidUrl

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Url

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Url

Available on crate feature schema only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_g: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for Url

fn cmp(&self, other: &Url) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Url

fn eq(&self, other: &Url) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Url

fn partial_cmp(&self, other: &Url) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Url

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Url

impl Validate for Url

fn validate_in(&self, v: &mut Validator)

Appends this value’s violations to v, relative to v’s current position.

fn validate(&self) -> Result<(), Violations>

Validates this value as the root of an object graph.