API
#net/url
Xu 0.8.8 API
import: #net/url
counts: 7 fns, 22 methods, 2 types, 0 consts, 0 ifaces
URL and query encode/decode.
struct URL
pub struct URL {
pub scheme string
pub host string
pub path string
pub raw_query string
pub fragment string
pub has_auth bool
}
Purpose
Public struct `URL`.
Parameters
scheme string- field (string)
host string- host
path string- filesystem path
raw_query string- field (string)
fragment string- field (string)
has_auth bool- field (bool)
(URL) scheme
pub fn (u URL) scheme() string
Purpose
Call `scheme` on `URL`.
Parameters
u URL- receiver URL (value receiver)
Returns
string — result string
(URL) host
pub fn (u URL) host() string
Purpose
Method on `URL`: host.
Parameters
u URL- receiver URL (value receiver)
Returns
string — result string
(URL) path
pub fn (u URL) path() string
Purpose
Call `path` on `URL`.
Parameters
u URL- receiver URL (value receiver)
Returns
string — result string
(URL) raw_query
pub fn (u URL) raw_query() string
Purpose
Method on `URL`: raw query.
Parameters
u URL- receiver URL (value receiver)
Returns
string — result string
(URL) fragment
pub fn (u URL) fragment() string
Purpose
Call `fragment` on `URL`.
Parameters
u URL- receiver URL (value receiver)
Returns
string — result string
(URL) query
pub fn (u URL) query() Query
Purpose
Call `query` on `URL`. Throws on failure.
Parameters
u URL- receiver URL (value receiver)
Returns
Query — a value of this type
(URL) hostname
pub fn (u URL) hostname() string
Purpose
Call `hostname` on `URL`.
Parameters
u URL- receiver URL (value receiver)
Returns
string — result string
(URL) port
pub fn (u URL) port() string
Purpose
Method on `URL`: port.
Parameters
u URL- receiver URL (value receiver)
Returns
string — result string
(URL) request_uri
pub fn (u URL) request_uri() string
Purpose
Method on `URL`: request uri.
Parameters
u URL- receiver URL (value receiver)
Returns
string — result string
(URL) join_path
pub fn (u URL) join_path(elem <-> string) URL
Purpose
Method on `URL`: join path.
Parameters
u URL- receiver URL (value receiver)
elem <-> string- variadic string (seen inside the function as []string)
Returns
URL — a value of this type
new_url
Purpose
new_url returns an empty URL for in-place parse.
Parameters
none
Returns
URL — a value of this type
parse_url
pub fn parse_url(s string) URL
Purpose
Parse as url.
Parameters
s string- source string (string)
Returns
URL — a value of this type
(&mut URL) parse
pub fn (u &mut URL) parse(s string) int
Purpose
parse fills u from a raw URL (RFC 3986 appendix B shape scheme://host/path?query#fragment). On error the URL keeps its previous components — never a partial parse result. Throws on failure.
Parameters
u &mut URL- receiver &mut URL (exclusive borrow)
s string- source string (string)
Returns
int — a value of this type
(URL) to_string
pub fn (u URL) to_string() string
Purpose
to_string re-emits the URL from its stored components ( URL.String).
Parameters
u URL- receiver URL (value receiver)
Returns
string — result string
struct Query
pub struct Query {
pub pairs []string
}
Purpose
Public struct `Query`.
Parameters
pairs []string- field ([]string)
new_query
Purpose
Construct query.
Parameters
none
Returns
Query — a value of this type
(Query) len
pub fn (q Query) len() int
Purpose
Method on `Query`: return the length.
Parameters
q Query- receiver Query (value receiver)
Returns
int — a value of this type
(Query) at
pub fn (q Query) at(i int) string
Purpose
Call `at` on `Query`.
Parameters
q Query- receiver Query (value receiver)
i int- index or integer (int)
Returns
string — result string
(&mut Query) parse
pub fn (q &mut Query) parse(query string) int
Purpose
parse decodes a query string into "key=value" pairs ('+' is a space, %XX are unescaped; '=' always present). Bad escapes throw — never a partial result. Caller-owned Query: pairs live in q. Throws on failure.
Parameters
q &mut Query- receiver &mut Query (exclusive borrow)
query string- query (string)
Returns
int — a value of this type
query_unescape
pub fn query_unescape(s &string) string
Purpose
query_escape percent-encodes for a query component: unreserved (a-Za-z0-9-._~) kept, space becomes '+', everything else %XX. Throws on failure.
Parameters
s &string- source string (borrowed; caller keeps it; type &string)
Returns
string — result string
path_unescape
pub fn path_unescape(s &string) string
Purpose
Path unescape. Throws on failure.
Parameters
s &string- source string (borrowed; caller keeps it; type &string)
Returns
string — result string
(Query) get
pub fn (q Query) get(key string) string
Purpose
Call `get` on `Query`.
Parameters
q Query- receiver Query (value receiver)
key string- key (string)
Returns
string — result string
(&mut Query) set
pub fn (q &mut Query) set(key string, val string)
Purpose
Call `set` on `&mut Query`.
Parameters
q &mut Query- receiver &mut Query (exclusive borrow)
key string- key (string)
val string- value (string)
(&mut Query) add
pub fn (q &mut Query) add(key string, val string)
Purpose
Method on `&mut Query`: add.
Parameters
q &mut Query- receiver &mut Query (exclusive borrow)
key string- key (string)
val string- value (string)
(&mut Query) del
pub fn (q &mut Query) del(key string)
Purpose
Call `del` on `&mut Query`.
Parameters
q &mut Query- receiver &mut Query (exclusive borrow)
key string- key (string)
(Query) has
pub fn (q Query) has(key string) bool
Purpose
Call `has` on `Query`.
Parameters
q Query- receiver Query (value receiver)
key string- key (string)
Returns
bool — true or false
(Query) encode
pub fn (q Query) encode() string
Purpose
Method on `Query`: encode.
Parameters
q Query- receiver Query (value receiver)
Returns
string — result string
query_escape
pub fn query_escape(s &string) string
Purpose
Query escape.
Parameters
s &string- source string (borrowed; caller keeps it; type &string)
Returns
string — result string
path_escape
pub fn path_escape(s &string) string
Purpose
path_escape percent-encodes for a path segment: unreserved plus $&+,/:;=@ kept, everything else %XX (space becomes %20).
Parameters
s &string- source string (borrowed; caller keeps it; type &string)
Returns
string — result string
(&URL) resolve_reference
pub fn (base &URL) resolve_reference(ref string) URL
Purpose
resolve_reference is URL.ResolveReference for this RFC 3986 subset (scheme/host/path/query/fragment; no userinfo). Throws on failure.
Parameters
base &URL- receiver &URL (borrow)
ref string- ref (string)
Returns
URL — a value of this type