Struct query_string_builder::QueryString

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

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

Example

use query_string_builder::QueryString;

let qs = QueryString::new()
            .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<'a> QueryString<'a>

pub fn new() -> Self

Creates a new, empty query string builder.

pub fn with_value(self, key: &'a str, value: &'a str) -> Self

Appends a key-value pair to the query string.

Example

use query_string_builder::QueryString;

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

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

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

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

Example

use query_string_builder::QueryString;

let qs = QueryString::new()
            .with_opt_value("q", Some("🍎 apple"))
            .with_opt_value("f", None)
            .with_opt_value("category", Some("fruits and vegetables"));

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

pub fn push(&mut self, key: &'a str, value: &'a str) -> &Self

Appends a key-value pair to the query string.

Example

use query_string_builder::QueryString;

let mut qs = QueryString::new();
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(&mut self, key: &'a str, value: Option<&'a str>) -> &Self

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

Example

use query_string_builder::QueryString;

let mut qs = QueryString::new();
qs.push_opt("q", None);
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.

Trait Implementations

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

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

Returns a copy 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<'a> Default for QueryString<'a>

fn default() -> QueryString<'a>

Returns the “default value” for a type.

impl<'a> Display for QueryString<'a>

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

Formats the value using the given formatter.