Struct DatUrl

pub struct DatUrl<'a> { /* private fields */ }

Main structure exported. It holds a reference to the string itself, but it is capable of becoming owned, in order to send it across threads.

It accepts valid urls as well, such as HTTP, domains or IP based URLs. Mal-formed url data might fail, such as bad formatted IPv6 addresses. It is capable to clone the structure into a onwed reference, as it uses Cow internally.

Example

use parse_dat_url::DatUrl;

if let Ok(dat_url) = DatUrl::parse("dat://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+0.0.0.1/path/to+file.txt") {
  println!("{}", dat_url);
}

Implementations

impl<'a> DatUrl<'a>

pub fn parse(url: &str) -> Result<DatUrl<'_>, Error>

Main parsing operation. Returns a struct which makes reference to the &str passed, with the same lifetime.

It is capable to clone the structure into a onwed reference, as it uses Cow internally.

pub fn into_owned(self) -> DatUrl<'static>

Converts a DatUrl with a 'a lifetime into a owned struct, with the 'static lifetime.

Examples

use parse_dat_url::{DatUrl, Error};
// A dynamic URL example.
let url = String::from("dat://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+0.0.0.1/path/to+file.txt");
let dat_url = DatUrl::parse(&url)?;
let owned_dat_url : DatUrl<'static> = dat_url.into_owned();

pub fn scheme(&self) -> &Cow<'_, str>

Returns a reference to the scheme used on the url. If no scheme is provided on the string, it fallsback to dat://

pub fn host(&self) -> &Cow<'_, str>

Returns the host part of the url.

pub fn version(&self) -> &Option<Cow<'_, str>>

Returns a reference to the version on the dat url, if present.

pub fn path(&self) -> &Option<Cow<'_, str>>

Returns a reference to the path on the dat url, if present.

Trait Implementations

impl<'a> AsRef<Url> for DatUrl<'a>

fn as_ref(&self) -> &Url

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

impl<'a> Clone for DatUrl<'a>

fn clone(&self) -> DatUrl<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DatUrl<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for DatUrl<'a>

fn deserialize<D>(deserializer: D) -> Result<DatUrl<'a>, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Display for DatUrl<'a>

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

Formats the value using the given formatter.

impl<'a> From<DatUrl<'a>> for Url

fn from(dat_url: DatUrl<'a>) -> Self

Converts to this type from the input type.

impl<'a> FromStr for DatUrl<'a>

type Err = Error

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<'a> PartialEq for DatUrl<'a>

fn eq(&self, other: &DatUrl<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for DatUrl<'a>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a str> for DatUrl<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Eq for DatUrl<'a>

impl<'a> StructuralPartialEq for DatUrl<'a>