README
¶
uri
uri is a copy of net/url 1.19 except URI implements encoding.TextUnmarshaler and encoding.TextMarshaler.
Another notable change:
If URI is empty, the String method returns "#" rather than an empty string.
License
Go License
Documentation
¶
Overview ¶
Package uri parses URIs and implements query escaping.
Index ¶
- func JoinPath(base string, elem ...string) (result string, err error)
- func PathEscape(s string) string
- func PathUnescape(s string) (string, error)
- func QueryEscape(s string) string
- func QueryUnescape(s string) (string, error)
- type Error
- type EscapeError
- type InvalidHostError
- type URI
- func (u *URI) Clone() *URI
- func (u *URI) EscapedFragment() string
- func (u *URI) EscapedPath() string
- func (u *URI) Hostname() string
- func (u *URI) IsAbs() bool
- func (u *URI) JoinPath(elem ...string) *URI
- func (u *URI) MarshalBinary() (text []byte, err error)
- func (u *URI) MarshalText() (text []byte, err error)
- func (u *URI) Parse(ref string) (*URI, error)
- func (u *URI) Port() string
- func (u *URI) Query() Values
- func (u *URI) Redacted() string
- func (u *URI) RequestURI() string
- func (u *URI) ResolveReference(ref *URI) *URI
- func (u URI) String() string
- func (u *URI) UnmarshalBinary(text []byte) error
- func (u *URI) UnmarshalText(text []byte) error
- type Userinfo
- type Values
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func JoinPath ¶
JoinPath returns a URI string with the provided path elements joined to the existing path of base and the resulting path cleaned of any ./ or ../ elements.
func PathEscape ¶
PathEscape escapes the string so it can be safely placed inside a URI path segment, replacing special characters (including /) with %XX sequences as needed.
func PathUnescape ¶
PathUnescape does the inverse transformation of PathEscape, converting each 3-byte encoded substring of the form "%AB" into the hex-decoded byte 0xAB. It returns an error if any % is not followed by two hexadecimal digits.
PathUnescape is identical to QueryUnescape except that it does not unescape '+' to ' ' (space).
func QueryEscape ¶
QueryEscape escapes the string so it can be safely placed inside a URI query.
func QueryUnescape ¶
QueryUnescape does the inverse transformation of QueryEscape, converting each 3-byte encoded substring of the form "%AB" into the hex-decoded byte 0xAB. It returns an error if any % is not followed by two hexadecimal digits.
Types ¶
type EscapeError ¶
type EscapeError string
func (EscapeError) Error ¶
func (e EscapeError) Error() string
type InvalidHostError ¶
type InvalidHostError string
func (InvalidHostError) Error ¶
func (e InvalidHostError) Error() string
type URI ¶
type URI struct {
Scheme string
Opaque string // encoded opaque data
User *Userinfo // username and password information
Host string // host or host:port
Path string // path (relative paths may omit leading slash)
RawPath string // encoded path hint (see EscapedPath method)
OmitHost bool // do not emit empty host (authority)
ForceQuery bool // append a query ('?') even if RawQuery is empty
RawQuery string // encoded query values, without '?'
Fragment string // fragment for references, without '#'
RawFragment string // encoded fragment hint (see EscapedFragment method)
}
A URI represents a parsed URI (technically, a URI reference).
The general form represented is:
[scheme:][//[userinfo@]host][/]path[?query][#fragment]
URIs that do not start with a slash after the scheme are interpreted as:
scheme:opaque[?query][#fragment]
Note that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/. A consequence is that it is impossible to tell which slashes in the Path were slashes in the raw URI and which were %2f. This distinction is rarely important, but when it is, the code should use RawPath, an optional field which only gets set if the default encoding is different from Path.
URI's String method uses the EscapedPath method to obtain the path. See the EscapedPath method for more details.
func MustParse ¶ added in v0.0.2
MustParse parses a raw uri into a URI structure and panics there are errors.
The uri may be relative (a path, without a host) or absolute (starting with a scheme). Trying to parse a hostname and path without a scheme is invalid but may not necessarily panic, due to parsing ambiguities.
func Parse ¶
Parse parses a raw uri into a URI structure.
The uri may be relative (a path, without a host) or absolute (starting with a scheme). Trying to parse a hostname and path without a scheme is invalid but may not necessarily return an error, due to parsing ambiguities.
func ParseRequestURI ¶
ParseRequestURI parses a raw uri into a URI structure. It assumes that uri was received in an HTTP request, so the uri is interpreted only as an absolute URI or an absolute path. The string uri is assumed not to have a #fragment suffix. (Web browsers strip #fragment before sending the URI to a web server.)
func (*URI) Clone ¶ added in v0.2.1
Clone returns a copy of the URI. It simply copies User if available.
func (*URI) EscapedFragment ¶
EscapedFragment returns the escaped form of u.Fragment. In general there are multiple possible escaped forms of any fragment. EscapedFragment returns u.RawFragment when it is a valid escaping of u.Fragment. Otherwise EscapedFragment ignores u.RawFragment and computes an escaped form on its own. The String method uses EscapedFragment to construct its result. In general, code should call EscapedFragment instead of reading u.RawFragment directly.
func (*URI) EscapedPath ¶
EscapedPath returns the escaped form of u.Path. In general there are multiple possible escaped forms of any path. EscapedPath returns u.RawPath when it is a valid escaping of u.Path. Otherwise EscapedPath ignores u.RawPath and computes an escaped form on its own. The String and RequestURI methods use EscapedPath to construct their results. In general, code should call EscapedPath instead of reading u.RawPath directly.
func (*URI) Hostname ¶
Hostname returns u.Host, stripping any valid port number if present.
If the result is enclosed in square brackets, as literal IPv6 addresses are, the square brackets are removed from the result.
func (*URI) IsAbs ¶
IsAbs reports whether the URI is absolute. Absolute means that it has a non-empty scheme.
func (*URI) JoinPath ¶
JoinPath returns a new URI with the provided path elements joined to any existing path and the resulting path cleaned of any ./ or ../ elements. Any sequences of multiple / characters will be reduced to a single /.
func (*URI) MarshalBinary ¶
func (*URI) MarshalText ¶
MarshalText implements encoding.TextMarshaler
func (*URI) Parse ¶
Parse parses a URI in the context of the receiver. The provided URI may be relative or absolute. Parse returns nil, err on parse failure, otherwise its return value is the same as ResolveReference.
func (*URI) Port ¶
Port returns the port part of u.Host, without the leading colon.
If u.Host doesn't contain a valid numeric port, Port returns an empty string.
func (*URI) Query ¶
Query parses RawQuery and returns the corresponding values. It silently discards malformed value pairs. To check errors use ParseQuery.
func (*URI) Redacted ¶
Redacted is like String but replaces any password with "xxxxx". Only the password in u.URI is redacted.
func (*URI) RequestURI ¶
RequestURI returns the encoded path?query or opaque?query string that would be used in an HTTP request for u.
func (*URI) ResolveReference ¶
ResolveReference resolves a URI reference to an absolute URI from an absolute base URI u, per RFC 3986 Section 5.2. The URI reference may be relative or absolute. ResolveReference always returns a new URI instance, even if the returned URI is identical to either the base or reference. If ref is an absolute URI, then ResolveReference ignores base and returns a copy of ref.
func (URI) String ¶
String reassembles the URI into a valid URI string. The general form of the result is one of:
scheme:opaque?query#fragment scheme://userinfo@host/path?query#fragment
If u.Opaque is non-empty, String uses the first form; otherwise it uses the second form. Any non-ASCII characters in host are escaped. To obtain the path, String uses u.EscapedPath().
In the second form, the following rules apply:
- if u.Scheme is empty, scheme: is omitted.
- if u.User is nil, userinfo@ is omitted.
- if u.Host is empty, host/ is omitted.
- if u.Scheme and u.Host are empty and u.User is nil, the entire scheme://userinfo@host/ is omitted.
- if u.Host is non-empty and u.Path begins with a /, the form host/path does not add its own /.
- if u.RawQuery is empty, ?query is omitted.
- if u.Fragment is empty, #fragment is omitted.
func (*URI) UnmarshalBinary ¶
func (*URI) UnmarshalText ¶
UnmarshalText implements encoding.TextUnmarshaler
type Userinfo ¶
type Userinfo struct {
// contains filtered or unexported fields
}
The Userinfo type is an immutable encapsulation of username and password details for a URI. An existing Userinfo value is guaranteed to have a username set (potentially empty, as allowed by RFC 2396), and optionally a password.
func UserPassword ¶
UserPassword returns a Userinfo containing the provided username and password.
This functionality should only be used with legacy web sites. RFC 2396 warns that interpreting Userinfo this way “is NOT RECOMMENDED, because the passing of authentication information in clear text (such as URI) has proven to be a security risk in almost every case where it has been used.”
func (*Userinfo) Password ¶ added in v0.2.2
Password returns the password in case it is set, and whether it is set.
type Values ¶
Values maps a string key to a list of values. It is typically used for query parameters and form values. Unlike in the http.Header map, the keys in a Values map are case-sensitive.
func ParseQuery ¶
ParseQuery parses the URI-encoded query string and returns a map listing the values specified for each key. ParseQuery always returns a non-nil map containing all the valid query parameters found; err describes the first decoding error encountered, if any.
Query is expected to be a list of key=value settings separated by ampersands. A setting without an equals sign is interpreted as a key set to an empty value. Settings containing a non-URI-encoded semicolon are considered invalid.
func (Values) Add ¶ added in v0.2.2
Add adds the value to key. It appends to any existing values associated with key.
func (Values) Encode ¶ added in v0.2.2
Encode encodes the values into “URI encoded” form ("bar=baz&foo=quux") sorted by key.
func (Values) Get ¶ added in v0.2.2
Get gets the first value associated with the given key. If there are no values associated with the key, Get returns the empty string. To access multiple values, use the map directly.
Source Files