Struct QueryString 

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

A parsed query string with efficient access to parameters.

Query strings are parsed lazily - the input is stored and parsed on each access. For repeated access patterns, consider using to_pairs() to materialize the results.

Implementations

impl<'a> QueryString<'a>

pub fn parse(raw: &'a str) -> Self

Parse a query string (without the leading ?).

Example

use fastapi_http::QueryString;

let qs = QueryString::parse("name=alice&age=30");
assert_eq!(qs.get("name"), Some("alice"));

pub fn is_empty(&self) -> bool

Returns true if the query string is empty.

pub fn raw(&self) -> &'a str

Returns the raw query string.

pub fn get(&self, key: &str) -> Option<&'a str>

Get the first value for a key.

Returns None if the key doesn’t exist. Returns the raw (percent-encoded) value. Use get_decoded for decoded values.

Example

use fastapi_http::QueryString;

let qs = QueryString::parse("name=alice&name=bob");
assert_eq!(qs.get("name"), Some("alice")); // First value
assert_eq!(qs.get("missing"), None);

pub fn get_all(&self, key: &str) -> impl Iterator<Item = &'a str>

Get all values for a key.

Returns an iterator over all values for the given key.

Example

use fastapi_http::QueryString;

let qs = QueryString::parse("color=red&color=blue&color=green");
let colors: Vec<_> = qs.get_all("color").collect();
assert_eq!(colors, vec!["red", "blue", "green"]);

pub fn get_decoded(&self, key: &str) -> Option<Cow<'a, str>>

Get the first value for a key, percent-decoded.

Returns a Cow that is borrowed if no decoding was needed, or owned if percent-decoding was performed.

Example

use fastapi_http::QueryString;

let qs = QueryString::parse("msg=hello%20world");
assert_eq!(qs.get_decoded("msg").as_deref(), Some("hello world"));

pub fn contains(&self, key: &str) -> bool

Check if a key exists in the query string.

Example

use fastapi_http::QueryString;

let qs = QueryString::parse("flag&name=alice");
assert!(qs.contains("flag"));
assert!(qs.contains("name"));
assert!(!qs.contains("missing"));

pub fn pairs(&self) -> impl Iterator<Item = (&'a str, &'a str)>

Returns an iterator over all key-value pairs.

Keys without values (like ?flag) have empty string values. Values are NOT percent-decoded; use pairs_decoded for that.

Example

use fastapi_http::QueryString;

let qs = QueryString::parse("a=1&b=2&flag");
let pairs: Vec<_> = qs.pairs().collect();
assert_eq!(pairs, vec![("a", "1"), ("b", "2"), ("flag", "")]);

pub fn pairs_decoded(&self) -> impl Iterator<Item = (&'a str, Cow<'a, str>)>

Returns an iterator over all key-value pairs, with values percent-decoded.

Example

use fastapi_http::QueryString;

let qs = QueryString::parse("name=hello%20world&id=123");
let pairs: Vec<_> = qs.pairs_decoded().collect();
assert_eq!(pairs[0].0, "name");
assert_eq!(&*pairs[0].1, "hello world");

pub fn to_pairs(&self) -> Vec<(&'a str, &'a str)>

Collect all pairs into a vector.

Useful when you need to iterate multiple times.

pub fn len(&self) -> usize

Count the number of parameters.

Trait Implementations

impl<'a> Clone for QueryString<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for QueryString<'a>

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

Formats the value using the given formatter.

impl Default for QueryString<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq for QueryString<'a>

fn eq(&self, other: &QueryString<'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> Eq for QueryString<'a>

impl<'a> StructuralPartialEq for QueryString<'a>