Struct Url

Source

pub struct Url { /* private fields */ }

Expand description

A URL that can represent either a web URL or a local file path.

This type provides an ergonomic interface for working with both web URLs (http/https) and local file paths in a unified way.

§Examples

use waterui_url::Url;

// Web URLs
let web_url = Url::parse("https://example.com/image.jpg").unwrap();
assert!(web_url.is_web());
assert_eq!(web_url.scheme(), Some("https"));

// Local file paths
let file_url = Url::from_file_path("/home/user/image.jpg");
assert!(file_url.is_local());

// Automatic detection
let auto_url = Url::new("./relative/path.png");
assert!(auto_url.is_local());

Implementations§

Source §

impl Url

Source

pub const fn new(url: &'static str) -> Url

Creates a URL from a static string at compile time.

This function can be evaluated at compile time and automatically detects the URL type (web, local, data, or blob).

For runtime string parsing, use the FromStr trait instead: url_string.parse::<Url>().

§Panics

Panics if the URL is malformed. This enables compile-time syntax checking: invalid URLs will cause compilation errors when used in const contexts.

// This will fail at compile time - missing host
const INVALID: Url = Url::new("https://");

§Examples

use waterui_url::Url;

const WEB_URL: Url = Url::new("https://example.com");
const LOCAL_PATH: Url = Url::new("/absolute/path");
const RELATIVE: Url = Url::new("./relative/path");

Source

pub fn parse(url: impl AsRef<str>) -> Option<Url>

Parses a URL string, validating it as a proper web URL.

Returns None if the URL is not a valid web URL.

§Examples

use waterui_url::Url;

assert!(Url::parse("https://example.com").is_some());
assert!(Url::parse("http://localhost:3000").is_some());
assert!(Url::parse("/local/path").is_none());

Source

pub fn from_file_path_str(path: impl Into<Str>) -> Url

Creates a URL from a file path string.

Source

pub fn from_data(mime_type: &str, data: &[u8]) -> Url

Creates a data URL from content and MIME type.

§Examples

use waterui_url::Url;

let url = Url::from_data("image/png", b"...");
assert!(url.is_data());

Source

pub const fn is_web(&self) -> bool

Returns true if this is a web URL (http/https/ftp etc).

Source

pub const fn is_local(&self) -> bool

Returns true if this is a local file path.

Source

pub const fn is_data(&self) -> bool

Returns true if this is a data URL.

Source

pub const fn is_blob(&self) -> bool

Returns true if this is a blob URL.

Source

pub const fn is_absolute(&self) -> bool

Returns true if this is an absolute path or URL.

Source

pub fn inner(&self) -> Str

Returns the inner string representation of the URL.

Source

pub const fn is_relative(&self) -> bool

Returns true if this is a relative path.

Source

pub fn scheme(&self) -> Option<&str>

Gets the URL scheme (e.g., “http”, “https”, “file”, “data”).

This is now O(1) - no parsing required!

Source

pub fn host(&self) -> Option<&str>

Gets the host for web URLs.

This is now O(1) - no parsing required!

Source

pub fn path(&self) -> &str

Gets the path component of the URL.

This is now O(1) - no parsing required!

Source

pub fn port(&self) -> Option<u16>

Gets the port number for web URLs.

This is a new method enabled by the parsed component structure! Returns the port as a u16, or None if not present.

Source

pub fn query(&self) -> Option<&str>

Gets the query string (without the ‘?’) for web URLs.

This is a new method enabled by the parsed component structure!

§Examples

use waterui_url::Url;

const URL: Url = Url::new("https://example.com/path?foo=bar&baz=qux");
assert_eq!(URL.query(), Some("foo=bar&baz=qux"));

Source

pub fn fragment(&self) -> Option<&str>

Gets the fragment (without the ‘#’) for web URLs.

This is a new method enabled by the parsed component structure!

§Examples

use waterui_url::Url;

const URL: Url = Url::new("https://example.com/path#section");
assert_eq!(URL.fragment(), Some("section"));

Source

pub fn authority(&self) -> Option<&str>

Gets the authority section (user:pass@host:port) for web URLs.

This is a new method enabled by the parsed component structure!

Source

pub fn extension(&self) -> Option<&str>

Gets the file extension if present.

Source

pub fn filename(&self) -> Option<&str>

Gets the filename from the URL path.

Source

pub fn join(&self, path: &str) -> Url

Joins this URL with a relative path.

§Examples

use waterui_url::Url;

let base = Url::new("https://example.com/images/");
let joined = base.join("photo.jpg");
assert_eq!(joined.as_str(), "https://example.com/images/photo.jpg");

Source