Url Rust Reference Documentation

Url

Current Version: 11.6.1

Chilkat.Url

Parse a URL into its host, path, query, credentials, port, fragment, and TLS details.

Chilkat.Url is a focused URL parsing class. Given a full URL, it extracts the hostname, host type, login, password, path, query string, fragment, port, and SSL/TLS status into easy-to-read properties. It is useful when application code needs to inspect, validate, route, log, or pass URL parts to lower-level networking or API code.

Parse full URLs

Call ParseUrl to break a complete URL into structured properties that can be inspected individually.

Host and host type

Read the hostname and determine whether it is a DNS name, IPv4 address, or IPv6 address.

Path and query

Access the URL path, query string, and combined path-with-query value for request construction or routing.

Login and password

Extract embedded userinfo credentials when a URL contains a login and password component.

Port and TLS status

Determine the explicit or implied port and whether the URL represents an SSL/TLS connection.

Fragment handling

Read the URL fragment separately from the path and query for workflows that need anchor or client-side state information.

Common pattern: Use Url when the application needs to decompose a URL before making a request or applying custom logic. Parse the full URL, read the properties needed by the caller, then pass the relevant pieces to classes such as Chilkat.Http, Chilkat.Rest, or Chilkat.Socket. Use Url for parsing; use the higher-level networking classes to actually send the request.

For an extended overview, see Url Class Overview.

Object Creation

// Cargo.toml:
//     [dependencies]
//     chilkat = "11.6"

use chilkat::Url;

// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?;  // shorthand for Global::new().unlock_bundle(..)

let url = Url::new();
// ... the native object is freed when `url` goes out of scope.

pub fn new() -> Url

Creates the underlying native Chilkat object (Url also implements Default). Every method takes &self, so the object never needs to be declared mut. A Url is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.

impl Drop for Url

The native object is freed when the Url is dropped — when it goes out of scope, or explicitly with drop(url). There is no Dispose method to call.

Errors

Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<Url>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.

match url.some_method(...) {
    Ok(value) => println!("{value:?}"),
    Err(e) => eprintln!("{}", e.last_error_text()),
}

Properties

DebugLogFilePath

// read/write
pub fn debug_log_file_path(&self) -> String
pub fn set_debug_log_file_path(&self, value: &str)

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Url Rust Reference Documentation

Url

Current Version: 11.6.1

Parse a URL into its host, path, query, credentials, port, fragment, and TLS details.

Parse full URLs

Host and host type

Path and query

Login and password

Port and TLS status

Fragment handling

Object Creation

Errors

Properties

DebugLogFilePath

Frag

Host

HostType

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

Login

Password

Path

PathWithQueryParams

Port

Query

Scheme

Ssl

VerboseLogging

Version

Methods

ParseUrl