Struct iri_string::types::RiQueryString

source · [−]

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

Expand description

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

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

For details, see the documentation for RiQueryStr.

Enabled by alloc or std feature.

Implementations

source

impl<S: Spec> RiQueryString<S>

source

pub fn shrink_to_fit(&mut self)

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

source

pub fn capacity(&self) -> usize

Returns the internal buffer capacity in bytes.

source

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

Returns the borrowed IRI string slice.

This is equivalent to &*self.

source

impl RiQueryString<IriSpec>

Conversion from an IRI into a URI.

source

pub fn encode_to_uri_inline(&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, or if you need more precise control over memory allocation and buffer handling, use encode_to_uri method.

Panics

Panics if the memory allocation failed.

Examples

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

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

source

pub fn try_encode_to_uri_inline(&mut self) -> Result<(), TryReserveError>

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, or if you need more precise control over memory allocation and buffer handling, use encode_to_uri method.

Examples

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

let mut iri = IriQueryString::try_from("alpha-is-\u{03B1}")?;
iri.try_encode_to_uri_inline()
    .expect("failed to allocate memory");
assert_eq!(iri, "alpha-is-%CE%B1");

source

pub fn encode_into_uri(self) -> UriQueryString

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

If you want a new URI string rather than modifying the IRI string, or if you need more precise control over memory allocation and buffer handling, use encode_to_uri method.

Examples

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

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

source

pub fn try_encode_into_uri(self) -> Result<UriQueryString, TryReserveError>

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

If you want a new URI string rather than modifying the IRI string, or if you need more precise control over memory allocation and buffer handling, use encode_to_uri method.

Examples

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

let iri = IriQueryString::try_from("alpha-is-\u{03B1}")?;
// Type annotation here is not necessary.
let uri: UriQueryString = iri.try_encode_into_uri()
    .expect("failed to allocate memory");
assert_eq!(uri, "alpha-is-%CE%B1");

source

pub fn try_into_uri(self) -> Result<UriQueryString, IriQueryString>

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

Examples

use iri_string::types::{IriQueryString, UriQueryString};

let ascii_iri = IriQueryString::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 = IriQueryString::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 = RiQueryStr<S>>

source

pub fn as_str(&self) -> &str

Returns &str.

source

pub fn len(&self) -> usize

Returns the string length.

source

pub fn is_empty(&self) -> bool

Returns whether the string is empty.

source

pub fn encode_to_uri(&self) -> MappedToUri<'_, Self>

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::format::ToDedicatedString;
use iri_string::types::{IriQueryStr, UriQueryString};

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

source

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

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

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

Examples

use iri_string::types::{IriQueryStr, UriQueryStr};

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

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