Struct UrlBuilder 

pub struct UrlBuilder { /* private fields */ }

Fluent URL builder.

Build a URL incrementally by chaining setter methods, then call build to produce the final String.

Path segments are automatically percent-encoded. Query parameters are form-encoded. No validation of scheme or host is performed — this is a string-composition helper, not a full URL parser.

Implementations

impl UrlBuilder

pub fn new() -> Self

Create an empty UrlBuilder.

pub fn scheme(self, scheme: impl Into<String>) -> Self

Set the URL scheme (e.g. "https").

Examples

use api_bones::url::UrlBuilder;

let url = UrlBuilder::new().scheme("https").host("example.com").build();
assert_eq!(url, "https://example.com");

pub fn host(self, host: impl Into<String>) -> Self

Set the host (e.g. "api.example.com").

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

Set an optional port number.

Examples

use api_bones::url::UrlBuilder;

let url = UrlBuilder::new()
    .scheme("http")
    .host("localhost")
    .port(8080)
    .build();
assert_eq!(url, "http://localhost:8080");

pub fn path(self, segment: impl Into<String>) -> Self

Append a path segment (will be percent-encoded).

Call multiple times to build up /a/b/c style paths.

Examples

use api_bones::url::UrlBuilder;

let url = UrlBuilder::new()
    .scheme("https")
    .host("example.com")
    .path("v1")
    .path("users")
    .path("hello world")
    .build();
assert_eq!(url, "https://example.com/v1/users/hello%20world");

pub fn query(self, key: impl Into<String>, value: impl ToString) -> Self

Append a query parameter (key and value are form-encoded).

Examples

use api_bones::url::UrlBuilder;

let url = UrlBuilder::new()
    .scheme("https")
    .host("example.com")
    .query("q", "hello world")
    .build();
assert_eq!(url, "https://example.com?q=hello+world");

pub fn fragment(self, fragment: impl Into<String>) -> Self

Set the URL fragment (the part after #).

Examples

use api_bones::url::UrlBuilder;

let url = UrlBuilder::new()
    .scheme("https")
    .host("example.com")
    .fragment("section-1")
    .build();
assert_eq!(url, "https://example.com#section-1");

pub fn build(&self) -> String

Produce the final URL string.

Examples

use api_bones::url::UrlBuilder;

let url = UrlBuilder::new()
    .scheme("https")
    .host("api.example.com")
    .path("v1")
    .path("items")
    .query("page", 2u32)
    .fragment("top")
    .build();

assert_eq!(url, "https://api.example.com/v1/items?page=2#top");

Trait Implementations

impl Clone for UrlBuilder

fn clone(&self) -> UrlBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UrlBuilder

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

Formats the value using the given formatter.

impl Default for UrlBuilder

fn default() -> UrlBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UrlBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UrlBuilder

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

Formats the value using the given formatter.

impl Serialize for UrlBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.