| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="rust-url is an implementation of the URL Standard for the Rust programming language."><meta name="keywords" content="rust, rustlang, rust-lang, url"><title>url - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../url/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../url/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate url</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 2.3.1</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">url</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/url/lib.rs.html#9-2923">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>rust-url is an implementation of the <a href="http://url.spec.whatwg.org/">URL Standard</a> |
| for the <a href="http://rust-lang.org/">Rust</a> programming language.</p> |
| <h2 id="url-parsing-and-data-structures"><a href="#url-parsing-and-data-structures">URL parsing and data structures</a></h2> |
| <p>First, URL parsing may fail for various reasons and therefore returns a <code>Result</code>.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>url::{Url, ParseError}; |
| |
| <span class="macro">assert!</span>(Url::parse(<span class="string">"http://[:::1]"</span>) == <span class="prelude-val">Err</span>(ParseError::InvalidIpv6Address))</code></pre></div> |
| <p>Let’s parse a valid URL and look at its components.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>url::{Url, Host, Position}; |
| <span class="kw">let </span>issue_list_url = Url::parse( |
| <span class="string">"https://github.com/rust-lang/rust/issues?labels=E-easy&state=open" |
| </span>)<span class="question-mark">?</span>; |
| |
| |
| <span class="macro">assert!</span>(issue_list_url.scheme() == <span class="string">"https"</span>); |
| <span class="macro">assert!</span>(issue_list_url.username() == <span class="string">""</span>); |
| <span class="macro">assert!</span>(issue_list_url.password() == <span class="prelude-val">None</span>); |
| <span class="macro">assert!</span>(issue_list_url.host_str() == <span class="prelude-val">Some</span>(<span class="string">"github.com"</span>)); |
| <span class="macro">assert!</span>(issue_list_url.host() == <span class="prelude-val">Some</span>(Host::Domain(<span class="string">"github.com"</span>))); |
| <span class="macro">assert!</span>(issue_list_url.port() == <span class="prelude-val">None</span>); |
| <span class="macro">assert!</span>(issue_list_url.path() == <span class="string">"/rust-lang/rust/issues"</span>); |
| <span class="macro">assert!</span>(issue_list_url.path_segments().map(|c| c.collect::<Vec<<span class="kw">_</span>>>()) == |
| <span class="prelude-val">Some</span>(<span class="macro">vec!</span>[<span class="string">"rust-lang"</span>, <span class="string">"rust"</span>, <span class="string">"issues"</span>])); |
| <span class="macro">assert!</span>(issue_list_url.query() == <span class="prelude-val">Some</span>(<span class="string">"labels=E-easy&state=open"</span>)); |
| <span class="macro">assert!</span>(<span class="kw-2">&</span>issue_list_url[Position::BeforePath..] == <span class="string">"/rust-lang/rust/issues?labels=E-easy&state=open"</span>); |
| <span class="macro">assert!</span>(issue_list_url.fragment() == <span class="prelude-val">None</span>); |
| <span class="macro">assert!</span>(!issue_list_url.cannot_be_a_base());</code></pre></div> |
| <p>Some URLs are said to be <em>cannot-be-a-base</em>: |
| they don’t have a username, password, host, or port, |
| and their “path” is an arbitrary string rather than slash-separated segments:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>url::Url; |
| |
| <span class="kw">let </span>data_url = Url::parse(<span class="string">"data:text/plain,Hello?World#"</span>)<span class="question-mark">?</span>; |
| |
| <span class="macro">assert!</span>(data_url.cannot_be_a_base()); |
| <span class="macro">assert!</span>(data_url.scheme() == <span class="string">"data"</span>); |
| <span class="macro">assert!</span>(data_url.path() == <span class="string">"text/plain,Hello"</span>); |
| <span class="macro">assert!</span>(data_url.path_segments().is_none()); |
| <span class="macro">assert!</span>(data_url.query() == <span class="prelude-val">Some</span>(<span class="string">"World"</span>)); |
| <span class="macro">assert!</span>(data_url.fragment() == <span class="prelude-val">Some</span>(<span class="string">""</span>));</code></pre></div> |
| <h3 id="serde"><a href="#serde">Serde</a></h3> |
| <p>Enable the <code>serde</code> feature to include <code>Deserialize</code> and <code>Serialize</code> implementations for <code>url::Url</code>.</p> |
| <h2 id="base-url"><a href="#base-url">Base URL</a></h2> |
| <p>Many contexts allow URL <em>references</em> that can be relative to a <em>base URL</em>:</p> |
| <div class="example-wrap"><pre class="language-html"><code><link rel="stylesheet" href="../main.css"></code></pre></div> |
| <p>Since parsed URLs are absolute, giving a base is required for parsing relative URLs:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>url::{Url, ParseError}; |
| |
| <span class="macro">assert!</span>(Url::parse(<span class="string">"../main.css"</span>) == <span class="prelude-val">Err</span>(ParseError::RelativeUrlWithoutBase))</code></pre></div> |
| <p>Use the <code>join</code> method on an <code>Url</code> to use it as a base URL:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>url::Url; |
| |
| <span class="kw">let </span>this_document = Url::parse(<span class="string">"http://servo.github.io/rust-url/url/index.html"</span>)<span class="question-mark">?</span>; |
| <span class="kw">let </span>css_url = this_document.join(<span class="string">"../main.css"</span>)<span class="question-mark">?</span>; |
| <span class="macro">assert_eq!</span>(css_url.as_str(), <span class="string">"http://servo.github.io/rust-url/main.css"</span>);</code></pre></div> |
| <h2 id="feature-serde"><a href="#feature-serde">Feature: <code>serde</code></a></h2> |
| <p>If you enable the <code>serde</code> feature, <a href="struct.Url.html"><code>Url</code></a> will implement |
| <a href="https://docs.rs/serde/1/serde/trait.Serialize.html"><code>serde::Serialize</code></a> and |
| <a href="https://docs.rs/serde/1/serde/trait.Deserialize.html"><code>serde::Deserialize</code></a>. |
| See <a href="https://serde.rs">serde documentation</a> for more information.</p> |
| <div class="example-wrap"><pre class="language-toml"><code>url = { version = "2", features = ["serde"] }</code></pre></div></div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.form_urlencoded"><code>pub use <a class="mod" href="../form_urlencoded/index.html" title="mod form_urlencoded">form_urlencoded</a>;</code></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OpaqueOrigin.html" title="url::OpaqueOrigin struct">OpaqueOrigin</a></div><div class="item-right docblock-short">Opaque identifier for URLs that have file or other schemes</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ParseOptions.html" title="url::ParseOptions struct">ParseOptions</a></div><div class="item-right docblock-short">Full configuration for the URL parser.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PathSegmentsMut.html" title="url::PathSegmentsMut struct">PathSegmentsMut</a></div><div class="item-right docblock-short">Exposes methods to manipulate the path of an URL that is not cannot-be-base.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Url.html" title="url::Url struct">Url</a></div><div class="item-right docblock-short">A parsed URL record.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UrlQuery.html" title="url::UrlQuery struct">UrlQuery</a></div><div class="item-right docblock-short">Implementation detail of <code>Url::query_pairs_mut</code>. Typically not used directly.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Host.html" title="url::Host enum">Host</a></div><div class="item-right docblock-short">The host name of an URL.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Origin.html" title="url::Origin enum">Origin</a></div><div class="item-right docblock-short">The origin of an URL</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ParseError.html" title="url::ParseError enum">ParseError</a></div><div class="item-right docblock-short">Errors that can occur during parsing.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Position.html" title="url::Position enum">Position</a></div><div class="item-right docblock-short">Indicates a position within a URL based on its components.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SyntaxViolation.html" title="url::SyntaxViolation enum">SyntaxViolation</a></div><div class="item-right docblock-short">Non-fatal syntax violations that can occur during parsing.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.EncodingOverride.html" title="url::EncodingOverride type">EncodingOverride</a></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="url" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
