Struct QueryString

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

Implementations

impl QueryString

pub fn simple<T>(input: &T) -> Result<Self, Error>

where T: Serialize,

pub fn nested<T>(input: &T) -> Result<Self, Error>

where T: Serialize,

Methods from Deref<Target = UriQueryStr>

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) -> MappedToUri<'_, RiQueryStr<IriSpec>>

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");

pub fn as_uri(&self) -> Option<&RiQueryStr<UriSpec>>

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);

Trait Implementations

impl Deref for QueryString

type Target = RiQueryStr<UriSpec>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.