Struct QueryStringOwned

Source

pub struct QueryStringOwned { /* private fields */ }

Expand description

An owning query string builder for percent encoding key-value pairs.

This is the lifetime-free twin of QueryString: it eagerly converts keys and values to owned Strings, so it can be stored in structs, returned from functions and passed around freely.

§Example

use query_string_builder::QueryStringOwned;

let qs = QueryStringOwned::new()
    .with("q", "apple")
    .with("tasty", true)
    .with_opt("category", Some("fruits and vegetables"));

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

Implementations§

Source §

impl QueryStringOwned

Source

pub fn new() -> Self

Creates a new, empty query string builder.

Source

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

Appends a key-value pair to the query string.

§Example

use query_string_builder::QueryStringOwned;

let qs = QueryStringOwned::new()
    .with("q", "🍎 apple")
    .with("category", "fruits and vegetables")
    .with("answer", 42);

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

Source

pub fn with_opt<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::QueryStringOwned;

let qs = QueryStringOwned::new()
    .with_opt("q", Some("🍎 apple"))
    .with_opt("f", None::<String>)
    .with_opt("category", Some("fruits and vegetables"))
    .with_opt("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"
);

Source

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

Appends a key-value pair to the query string.

§Example

use query_string_builder::QueryStringOwned;

let mut qs = QueryStringOwned::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"
);

Source

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

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

§Example

use query_string_builder::QueryStringOwned;

let mut qs = QueryStringOwned::new();
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"
);

Source

pub fn len(&self) -> usize

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

Source

pub fn is_empty(&self) -> bool

Determines if the builder is currently empty.

Source

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

Appends another query string builder’s values.

§Example

use query_string_builder::QueryStringOwned;

let mut qs = QueryStringOwned::new().with("q", "apple");
let more = QueryStringOwned::new().with("q", "pear");

qs.append(more);

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

Source

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

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

§Example

use query_string_builder::QueryStringOwned;

let qs = QueryStringOwned::new().with("q", "apple");
let more = QueryStringOwned::new().with("q", "pear");

let qs = qs.append_into(more);

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