Struct QueryString

pub struct QueryString { /* private fields */ }

A query string builder for percent encoding key-value pairs.

Example

use query_string_builder::QueryString;

let qs = QueryString::dynamic()
            .with_value("q", "apple")
            .with_value("category", "fruits and vegetables");

assert_eq!(
    format!("https://example.com/{qs}"),
    "https://example.com/?q=apple&category=fruits%20and%20vegetables"
);

Implementations

impl QueryString

pub fn simple() -> QueryStringSimple

Creates a new, empty query string builder.

Example

use query_string_builder::QueryString;

let weight: &f32 = &99.9;

let qs = QueryString::simple()
            .with_value("q", "apple")
            .with_value("category", "fruits and vegetables")
            .with_opt_value("weight", Some(weight));

assert_eq!(
    format!("https://example.com/{qs}"),
    "https://example.com/?q=apple&category=fruits%20and%20vegetables&weight=99.9"
);

pub fn dynamic() -> Self

Creates a new, empty query string builder.

pub fn with_value<K: ToString, V: ToString>(self, key: K, value: V) -> Self

Appends a key-value pair to the query string.

Example

use query_string_builder::QueryString;

let qs = QueryString::dynamic()
            .with_value("q", "🍎 apple")
            .with_value("category", "fruits and vegetables")
            .with_value("answer", 42);

assert_eq!(
    format!("https://example.com/{qs}"),
    "https://example.com/?q=%F0%9F%8D%8E%20apple&category=fruits%20and%20vegetables&answer=42"
);

pub fn with_opt_value<K: ToString, V: ToString>( self, key: K, value: Option<V>, ) -> Self

Appends a key-value pair to the query string if the value exists.

Example

use query_string_builder::QueryString;

let qs = QueryString::dynamic()
            .with_opt_value("q", Some("🍎 apple"))
            .with_opt_value("f", None::<String>)
            .with_opt_value("category", Some("fruits and vegetables"))
            .with_opt_value("works", Some(true));

assert_eq!(
    format!("https://example.com/{qs}"),
    "https://example.com/?q=%F0%9F%8D%8E%20apple&category=fruits%20and%20vegetables&works=true"
);

pub fn push<K: ToString, V: ToString>(&mut self, key: K, value: V) -> &Self

Appends a key-value pair to the query string.

Example

use query_string_builder::QueryString;

let mut qs = QueryString::dynamic();
qs.push("q", "apple");
qs.push("category", "fruits and vegetables");

assert_eq!(
    format!("https://example.com/{qs}"),
    "https://example.com/?q=apple&category=fruits%20and%20vegetables"
);

pub fn push_opt<K: ToString, V: ToString>( &mut self, key: K, value: Option<V>, ) -> &Self

Appends a key-value pair to the query string if the value exists.

Example

use query_string_builder::QueryString;

let mut qs = QueryString::dynamic();
qs.push_opt("q", None::<String>);
qs.push_opt("q", Some("🍎 apple"));

assert_eq!(
    format!("https://example.com/{qs}"),
    "https://example.com/?q=%F0%9F%8D%8E%20apple"
);

pub fn len(&self) -> usize

Determines the number of key-value pairs currently in the builder.

pub fn is_empty(&self) -> bool

Determines if the builder is currently empty.

pub fn append(&mut self, other: QueryString)

Appends another query string builder’s values.

Example

use query_string_builder::QueryString;

let mut qs = QueryString::dynamic().with_value("q", "apple");
let more = QueryString::dynamic().with_value("q", "pear");

qs.append(more);

assert_eq!(
    format!("https://example.com/{qs}"),
    "https://example.com/?q=apple&q=pear"
);

pub fn append_into(self, other: QueryString) -> Self

Appends another query string builder’s values, consuming both types.

Example

use query_string_builder::QueryString;

let qs = QueryString::dynamic().with_value("q", "apple");
let more = QueryString::dynamic().with_value("q", "pear");

let qs = qs.append_into(more);

assert_eq!(
    format!("https://example.com/{qs}"),
    "https://example.com/?q=apple&q=pear"
);

Trait Implementations

impl Clone for QueryString

fn clone(&self) -> QueryString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryString

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

Formats the value using the given formatter.

impl Display for QueryString

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

Formats the value using the given formatter.