Struct HttpUrlBuilder 

pub struct HttpUrlBuilder { /* private fields */ }

Builder for constructing HttpUrl values programmatically.

Example

use http_url::{HttpUrl, Scheme};

let url = HttpUrl::builder()
    .scheme(Scheme::Https)
    .host("example.com")
    .add_path_segment("api")
    .add_path_segment("v1")
    .add_query_parameter("key", "value")
    .fragment("section")
    .build()
    .unwrap();

assert_eq!(url.to_string(), "https://example.com/api/v1?key=value#section");

Implementations

impl HttpUrlBuilder

pub fn new() -> Self

Create a new empty builder.

pub fn scheme(self, scheme: Scheme) -> Self

Set the scheme.

pub fn username(self, username: &str) -> Self

Set the username for basic auth.

pub fn password(self, password: &str) -> Self

Set the password for basic auth.

pub fn host(self, host: &str) -> Self

Set the host (domain name or IP address).

pub fn port(self, port: u16) -> Self

Set the port. Use None to use the scheme’s default.

pub fn add_path_segment(self, segment: &str) -> Self

Add a path segment (decoded form, will be percent-encoded on build).

pub fn add_path_segments(self, segments: &[&str]) -> Self

Add multiple path segments.

pub fn set_path(self, path: &str) -> Self

Set the entire path from a decoded path string (e.g., /a/b/c). The path is split on / and each segment is decoded.

pub fn set_encoded_path(self, path: &str) -> Self

Set the entire path from an already-encoded path string. Each segment is percent-decoded before storage.

pub fn add_query_parameter(self, name: &str, value: &str) -> Self

Add a query parameter (name and value in decoded form).

pub fn remove_query_parameter(self, name: &str) -> Self

Remove all query parameters with the given name.

pub fn clear_query_parameters(self) -> Self

Clear all query parameters.

pub fn add_encoded_query_parameter(self, name: &str, value: &str) -> Self

Add a query parameter from already-encoded name and value.

pub fn fragment(self, fragment: &str) -> Self

Set the fragment (decoded form).

pub fn encoded_fragment(self, fragment: &str) -> Self

Set the fragment from an encoded form.

pub fn remove_fragment(self) -> Self

Remove the fragment.

pub fn build(self) -> Result<HttpUrl>

Consume the builder and produce an HttpUrl.

Returns an error if required components (scheme, host) are missing.

Trait Implementations

impl Clone for HttpUrlBuilder

fn clone(&self) -> HttpUrlBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpUrlBuilder

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

Formats the value using the given formatter.

impl Default for HttpUrlBuilder

fn default() -> Self

Returns the “default value” for a type.