Struct iri_string::types::RiFragmentString

pub struct RiFragmentString<S> { /* private fields */ }

An owned string of an IRI fragment (i.e. after the first # character).

This corresponds to ifragment rule in RFC 3987 (and fragment rule in RFC 3986). The rule for absolute-IRI is *( ipchar / "/" / "?" ).

For details, see the documentation for RiFragmentStr.

Enabled by alloc or std feature.

Implementations

impl<S: Spec> RiFragmentString<S>

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the inner buffer to match its length.

pub fn capacity(&self) -> usize

Returns the internal buffer capacity in bytes.

pub fn as_slice(&self) -> &RiFragmentStr<S>

Returns the borrowed IRI string slice.

This is equivalent to &*self.

impl RiFragmentString<IriSpec>

Conversion from an IRI into a URI.

pub fn encode_to_uri(&mut self)

Percent-encodes the IRI into a valid URI that identifies the equivalent resource.

After the encode, the IRI is also a valid URI.

If you want a new URI string rather than modifying the IRI string, use encode_into_uri method.

If you need more precise control over memory allocation and buffer handling, use MappedToUri type.

Examples

#[cfg(feature = "alloc")] {
use iri_string::types::IriFragmentString;

let mut iri = IriFragmentString::try_from("alpha-is-\u{03B1}")?;
iri.encode_to_uri();
assert_eq!(iri, "alpha-is-%CE%B1");

pub fn encode_into_uri(self) -> UriFragmentString

Percent-encodes the IRI into a valid URI that identifies the equivalent resource.

If you want to modify the value rather than creating a new URI string, use encode_to_uri method.

If you need more precise control over memory allocation and buffer handling, use MappedToUri type.

Examples

#[cfg(feature = "alloc")] {
use iri_string::types::{IriFragmentString, UriFragmentString};

let iri = IriFragmentString::try_from("alpha-is-\u{03B1}")?;
// Type annotation here is not necessary.
let uri: UriFragmentString = iri.encode_into_uri();
assert_eq!(uri, "alpha-is-%CE%B1");

pub fn try_into_uri(self) -> Result<UriFragmentString, IriFragmentString>

Converts an IRI into a URI without modification, if possible.

Examples

use iri_string::types::{IriFragmentString, UriFragmentString};

let ascii_iri = IriFragmentString::try_from("alpha-is-%CE%B1")?;
assert_eq!(
    ascii_iri.try_into_uri().map(|uri| uri.to_string()),
    Ok("alpha-is-%CE%B1".to_string())
);

let nonascii_iri = IriFragmentString::try_from("alpha-is-\u{03B1}")?;
assert_eq!(
    nonascii_iri.try_into_uri().map_err(|iri| iri.to_string()),
    Err("alpha-is-\u{03B1}".to_string())
);

Methods from Deref<Target = RiFragmentStr<S>>

pub fn as_str(&self) -> &str

Returns &str.

pub fn len(&self) -> usize

Returns the string length.

pub fn is_empty(&self) -> bool

Returns whether the string is empty.

pub fn encode_to_uri(&self) -> UriFragmentString

Percent-encodes the IRI into a valid URI that identifies the equivalent resource.

If you need more precise control over memory allocation and buffer handling, use MappedToUri type.

Examples

use iri_string::types::{IriFragmentStr, UriFragmentString};

let iri = IriFragmentStr::new("alpha-is-\u{03B1}")?;
// Type annotation here is not necessary.
let uri: UriFragmentString = iri.encode_to_uri();
assert_eq!(uri, "alpha-is-%CE%B1");

pub fn as_uri(&self) -> Option<&UriFragmentStr>

Converts an IRI into a URI without modification, if possible.

This is semantically equivalent to UriFragmentStr::new(self.as_str()).ok().

Examples

use iri_string::types::{IriFragmentStr, UriFragmentStr};

let ascii_iri = IriFragmentStr::new("alpha-is-%CE%B1")?;
assert_eq!(
    ascii_iri.as_uri().map(AsRef::as_ref),
    Some("alpha-is-%CE%B1")
);

let nonascii_iri = IriFragmentStr::new("alpha-is-\u{03B1}")?;
assert_eq!(nonascii_iri.as_uri(), None);

Trait Implementations

impl<S: Spec> AsRef<RiFragmentStr<S>> for RiFragmentString<S>

fn as_ref(&self) -> &RiFragmentStr<S>

Performs the conversion.

impl<S: Spec> AsRef<str> for RiFragmentString<S>

fn as_ref(&self) -> &str

Performs the conversion.

impl<S: Spec> Borrow<RiFragmentStr<S>> for RiFragmentString<S>

fn borrow(&self) -> &RiFragmentStr<S>

Immutably borrows from an owned value.

impl<S: Spec> Borrow<str> for RiFragmentString<S>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<S: Spec> Clone for RiFragmentString<S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Spec> Debug for RiFragmentString<S>

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

Formats the value using the given formatter.

impl<S: Spec> Deref for RiFragmentString<S>

type Target = RiFragmentStr<S>

The resulting type after dereferencing.

fn deref(&self) -> &RiFragmentStr<S>

Dereferences the value.

impl<'de, S: Spec> Deserialize<'de> for RiFragmentString<S>

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

Deserialize this value from the given Serde deserializer.

impl<S: Spec> Display for RiFragmentString<S>

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

Formats the value using the given formatter.

impl<S: Spec> From<&'_ RiFragmentStr<S>> for RiFragmentString<S>

fn from(s: &RiFragmentStr<S>) -> Self

Performs the conversion.

impl<'a> From<&'a RiFragmentString<IriSpec>> for MappedToUri<'a, IriFragmentStr>

fn from(iri: &'a IriFragmentString) -> Self

Performs the conversion.

impl<'a> From<&'a RiFragmentString<UriSpec>> for MappedToUri<'a, UriFragmentStr>

fn from(iri: &'a UriFragmentString) -> Self

Performs the conversion.

impl<S: Spec> From<RiFragmentString<S>> for String

fn from(s: RiFragmentString<S>) -> Self

Performs the conversion.

impl From<RiFragmentString<UriSpec>> for IriFragmentString

fn from(uri: UriFragmentString) -> Self

Performs the conversion.

impl<S: Spec> FromStr for RiFragmentString<S>

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<S: Spec> Hash for RiFragmentString<S>

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, 

Feeds a slice of this type into the given Hasher.

impl<S: Spec> Ord for RiFragmentString<S>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<S: Spec, T: Spec> PartialEq<&'_ RiFragmentStr<S>> for RiFragmentString<T>

fn eq(&self, o: &&RiFragmentStr<S>) -> bool

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

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

This method tests for !=.

impl<S: Spec> PartialEq<&'_ str> for RiFragmentString<S>

fn eq(&self, o: &&str) -> bool

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

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

This method tests for !=.

impl<S: Spec, T: Spec> PartialEq<Cow<'_, RiFragmentStr<S>>> for RiFragmentString<T>

fn eq(&self, o: &Cow<'_, RiFragmentStr<S>>) -> bool

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

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

This method tests for !=.

impl<S: Spec> PartialEq<Cow<'_, str>> for RiFragmentString<S>

fn eq(&self, o: &Cow<'_, str>) -> bool

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

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

This method tests for !=.

impl<S: Spec, T: Spec> PartialEq<RiFragmentStr<S>> for RiFragmentString<T>

fn eq(&self, o: &RiFragmentStr<S>) -> bool

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

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

This method tests for !=.

impl<S: Spec> PartialEq<RiFragmentString<S>> for str

fn eq(&self, o: &RiFragmentString<S>) -> bool

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

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

This method tests for !=.

impl<S: Spec> PartialEq<RiFragmentString<S>> for &str

fn eq(&self, o: &RiFragmentString<S>) -> bool

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

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

This method tests for !=.

impl<S: Spec> PartialEq<RiFragmentString<S>> for Cow<'_, str>

fn eq(&self, o: &RiFragmentString<S>) -> bool

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

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

This method tests for !=.

impl<S: Spec> PartialEq<RiFragmentString<S>> for String

fn eq(&self, o: &RiFragmentString<S>) -> bool

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

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

This method tests for !=.

impl<S: Spec, T: Spec> PartialEq<RiFragmentString<T>> for RiFragmentString<S>

fn eq(&self, other: &RiFragmentString<T>) -> bool

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

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

This method tests for !=.

impl<S: Spec, T: Spec> PartialEq<RiFragmentString<T>> for RiFragmentStr<S>

fn eq(&self, o: &RiFragmentString<T>) -> bool

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

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

This method tests for !=.

impl<S: Spec, T: Spec> PartialEq<RiFragmentString<T>> for &RiFragmentStr<S>

fn eq(&self, o: &RiFragmentString<T>) -> bool

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

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

This method tests for !=.

impl<S: Spec, T: Spec> PartialEq<RiFragmentString<T>> for Cow<'_, RiFragmentStr<S>>

fn eq(&self, o: &RiFragmentString<T>) -> bool

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

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

This method tests for !=.

impl<S: Spec> PartialEq<String> for RiFragmentString<S>

fn eq(&self, o: &String) -> bool

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

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

This method tests for !=.

impl<S: Spec> PartialEq<str> for RiFragmentString<S>

fn eq(&self, o: &str) -> bool

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

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

This method tests for !=.

impl<S: Spec, T: Spec> PartialOrd<&'_ RiFragmentStr<S>> for RiFragmentString<T>

fn partial_cmp(&self, o: &&RiFragmentStr<S>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec> PartialOrd<&'_ str> for RiFragmentString<S>

fn partial_cmp(&self, o: &&str) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec, T: Spec> PartialOrd<Cow<'_, RiFragmentStr<S>>> for RiFragmentString<T>

fn partial_cmp(&self, o: &Cow<'_, RiFragmentStr<S>>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec> PartialOrd<Cow<'_, str>> for RiFragmentString<S>

fn partial_cmp(&self, o: &Cow<'_, str>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec, T: Spec> PartialOrd<RiFragmentStr<S>> for RiFragmentString<T>

fn partial_cmp(&self, o: &RiFragmentStr<S>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec> PartialOrd<RiFragmentString<S>> for str

fn partial_cmp(&self, o: &RiFragmentString<S>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec> PartialOrd<RiFragmentString<S>> for &str

fn partial_cmp(&self, o: &RiFragmentString<S>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec> PartialOrd<RiFragmentString<S>> for Cow<'_, str>

fn partial_cmp(&self, o: &RiFragmentString<S>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec> PartialOrd<RiFragmentString<S>> for String

fn partial_cmp(&self, o: &RiFragmentString<S>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec, T: Spec> PartialOrd<RiFragmentString<T>> for RiFragmentString<S>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec, T: Spec> PartialOrd<RiFragmentString<T>> for RiFragmentStr<S>

fn partial_cmp(&self, o: &RiFragmentString<T>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec, T: Spec> PartialOrd<RiFragmentString<T>> for &RiFragmentStr<S>

fn partial_cmp(&self, o: &RiFragmentString<T>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec, T: Spec> PartialOrd<RiFragmentString<T>> for Cow<'_, RiFragmentStr<S>>

fn partial_cmp(&self, o: &RiFragmentString<T>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec> PartialOrd<String> for RiFragmentString<S>

fn partial_cmp(&self, o: &String) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Spec> PartialOrd<str> for RiFragmentString<S>

fn partial_cmp(&self, o: &str) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S> Serialize for RiFragmentString<S> where
    S: Spec, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<S: Spec> TryFrom<&'_ [u8]> for RiFragmentString<S>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<S: Spec> TryFrom<&'_ str> for RiFragmentString<S>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<S: Spec> TryFrom<String> for RiFragmentString<S>

type Error = CreationError<String>

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl<S: Spec> Eq for RiFragmentString<S>