Struct uriparse::query::Query

pub struct Query<'query> { /* fields omitted */ }

The query component as defined in [RFC3986, Section 3.4].

The query is case-sensitive. Furthermore, percent-encoding plays no role in equality checking for characters in the unreserved character set meaning that "query" and "que%72y" are identical. Both of these attributes are reflected in the equality and hash functions.

However, be aware that just because percent-encoding plays no role in equality checking does not mean that the query is normalized. If the query needs to be normalized, use the Query::normalize function.

Methods

impl<'_> Query<'_>

pub fn as_borrowed(&self) -> Query

Returns a new query which is identical but has a lifetime tied to this query.

pub fn as_str(&self) -> &str

Returns a str representation of the query.

Examples

use std::convert::TryFrom;

use uriparse::Query;

let query = Query::try_from("query").unwrap();
assert_eq!(query.as_str(), "query");

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

Converts the Query into an owned copy.

If you construct the query from a source with a non-static lifetime, you may run into lifetime problems due to the way the struct is designed. Calling this function will ensure that the returned value has a static lifetime.

This is different from just cloning. Cloning the query will just copy the references, and thus the lifetime will remain the same.

pub fn is_normalized(&self) -> bool

Returns whether the query is normalized.

A normalized query will have no bytes that are in the unreserved character set percent-encoded and all alphabetical characters in percent-encodings will be uppercase.

This function runs in constant-time.

Examples

use std::convert::TryFrom;

use uriparse::Query;

let query = Query::try_from("query").unwrap();
assert!(query.is_normalized());

let mut query = Query::try_from("%ff%ff").unwrap();
assert!(!query.is_normalized());
query.normalize();
assert!(query.is_normalized());

pub fn normalize(&mut self)

Normalizes the query such that it will have no bytes that are in the unreserved character set percent-encoded and all alphabetical characters in percent-encodings will be uppercase.

If the query is already normalized, the function will return immediately. Otherwise, if the query is not owned, this function will perform an allocation to clone it. The normalization itself though, is done in-place with no extra memory allocations required.

Examples

use std::convert::TryFrom;

use uriparse::Query;

let mut query = Query::try_from("query").unwrap();
query.normalize();
assert_eq!(query, "query");

let mut query = Query::try_from("%ff%41").unwrap();
assert_eq!(query, "%ff%41");
query.normalize();
assert_eq!(query, "%FFA");

Trait Implementations

impl<'_> AsRef<[u8]> for Query<'_>

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'_> AsRef<str> for Query<'_>

fn as_ref(&self) -> &str

Performs the conversion.

impl<'_> PartialEq<Query<'_>> for Query<'_>

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

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

#[must_use]

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

This method tests for !=.

impl<'_> PartialEq<[u8]> for Query<'_>

fn eq(&self, other: &[u8]) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'query> PartialEq<Query<'query>> for [u8]

fn eq(&self, other: &Query<'query>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, '_> PartialEq<&'a [u8]> for Query<'_>

fn eq(&self, other: &&'a [u8]) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, 'query> PartialEq<Query<'query>> for &'a [u8]

fn eq(&self, other: &Query<'query>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'_> PartialEq<str> for Query<'_>

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

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

#[must_use]

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

This method tests for !=.

impl<'query> PartialEq<Query<'query>> for str

fn eq(&self, other: &Query<'query>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, '_> PartialEq<&'a str> for Query<'_>

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

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

#[must_use]

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

This method tests for !=.

impl<'a, 'query> PartialEq<Query<'query>> for &'a str

fn eq(&self, other: &Query<'query>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'query> From<Query<'query>> for String

fn from(value: Query<'query>) -> Self

Performs the conversion.

impl<'query> Clone for Query<'query>

fn clone(&self) -> Query<'query>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'_> Eq for Query<'_>

impl<'_> Display for Query<'_>

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'query> Debug for Query<'query>

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

Formats the value using the given formatter.

impl<'_> Hash for Query<'_>

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

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<'_> Deref for Query<'_>

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl<'query> TryFrom<&'query [u8]> for Query<'query>

type Error = InvalidQuery

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'query> TryFrom<&'query str> for Query<'query>

type Error = InvalidQuery

The type returned in the event of a conversion error.

fn try_from(value: &'query str) -> Result<Self, Self::Error>

Performs the conversion.