package url

Import Path
	net/url (on go.dev)

Dependency Relation
	imports 5 packages, and imported by 2 packages

Involved Source Files

	   #d url.go
		Package url parses URLs and implements query escaping.
Code Examples

	ParseQuery
		package main
		
		import (
			"encoding/json"
			"fmt"
			"log"
			"net/url"
			"strings"
		)
		
		func main() {
			m, err := url.ParseQuery(`x=1&y=2&y=3;z`)
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(toJSON(m))
		}
		
		func toJSON(m interface{}) string {
			js, err := json.Marshal(m)
			if err != nil {
				log.Fatal(err)
			}
			return strings.ReplaceAll(string(js), ",", ", ")
		}

	URL
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, err := url.Parse("http://bing.com/search?q=dotnet")
			if err != nil {
				log.Fatal(err)
			}
			u.Scheme = "https"
			u.Host = "google.com"
			q := u.Query()
			q.Set("q", "golang")
			u.RawQuery = q.Encode()
			fmt.Println(u)
		}

	URL_EscapedFragment
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, err := url.Parse("http://example.com/#x/y%2Fz")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println("Fragment:", u.Fragment)
			fmt.Println("RawFragment:", u.RawFragment)
			fmt.Println("EscapedFragment:", u.EscapedFragment())
		}

	URL_EscapedPath
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, err := url.Parse("http://example.com/x/y%2Fz")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println("Path:", u.Path)
			fmt.Println("RawPath:", u.RawPath)
			fmt.Println("EscapedPath:", u.EscapedPath())
		}

	URL_Hostname
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, err := url.Parse("https://example.org:8000/path")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(u.Hostname())
			u, err = url.Parse("https://[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:17000")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(u.Hostname())
		}

	URL_IsAbs
		package main
		
		import (
			"fmt"
			"net/url"
		)
		
		func main() {
			u := url.URL{Host: "example.com", Path: "foo"}
			fmt.Println(u.IsAbs())
			u.Scheme = "http"
			fmt.Println(u.IsAbs())
		}

	URL_MarshalBinary
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, _ := url.Parse("https://example.org")
			b, err := u.MarshalBinary()
			if err != nil {
				log.Fatal(err)
			}
			fmt.Printf("%s\n", b)
		}

	URL_Parse
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, err := url.Parse("https://example.org")
			if err != nil {
				log.Fatal(err)
			}
			rel, err := u.Parse("/foo")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(rel)
			_, err = u.Parse(":foo")
			if _, ok := err.(*url.Error); !ok {
				log.Fatal(err)
			}
		}

	URL_Port
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, err := url.Parse("https://example.org")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(u.Port())
			u, err = url.Parse("https://example.org:8080")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(u.Port())
		}

	URL_Query
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, err := url.Parse("https://example.org/?a=1&a=2&b=&=3&&&&")
			if err != nil {
				log.Fatal(err)
			}
			q := u.Query()
			fmt.Println(q["a"])
			fmt.Println(q.Get("b"))
			fmt.Println(q.Get(""))
		}

	URL_Redacted
		package main
		
		import (
			"fmt"
			"net/url"
		)
		
		func main() {
			u := &url.URL{
				Scheme: "https",
				User:   url.UserPassword("user", "password"),
				Host:   "example.com",
				Path:   "foo/bar",
			}
			fmt.Println(u.Redacted())
			u.User = url.UserPassword("me", "newerPassword")
			fmt.Println(u.Redacted())
		}

	URL_RequestURI
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, err := url.Parse("https://example.org/path?foo=bar")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(u.RequestURI())
		}

	URL_ResolveReference
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u, err := url.Parse("../../..//search?q=dotnet")
			if err != nil {
				log.Fatal(err)
			}
			base, err := url.Parse("http://example.com/directory/")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(base.ResolveReference(u))
		}

	URL_String
		package main
		
		import (
			"fmt"
			"net/url"
		)
		
		func main() {
			u := &url.URL{
				Scheme:   "https",
				User:     url.UserPassword("me", "pass"),
				Host:     "example.com",
				Path:     "foo/bar",
				RawQuery: "x=1&y=2",
				Fragment: "anchor",
			}
			fmt.Println(u.String())
			u.Opaque = "opaque"
			fmt.Println(u.String())
		}

	URL_UnmarshalBinary
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			u := &url.URL{}
			err := u.UnmarshalBinary([]byte("https://example.org/foo"))
			if err != nil {
				log.Fatal(err)
			}
			fmt.Printf("%s\n", u)
		}

	URL_roundtrip
		package main
		
		import (
			"fmt"
			"log"
			"net/url"
		)
		
		func main() {
			// Parse + String preserve the original encoding.
			u, err := url.Parse("https://example.com/foo%2fbar")
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(u.Path)
			fmt.Println(u.RawPath)
			fmt.Println(u.String())
		}

	Values
		package main
		
		import (
			"fmt"
			"net/url"
		)
		
		func main() {
			v := url.Values{}
			v.Set("name", "Ava")
			v.Add("friend", "Jess")
			v.Add("friend", "Sarah")
			v.Add("friend", "Zoe")
			// v.Encode() == "name=Ava&friend=Jess&friend=Sarah&friend=Zoe"
			fmt.Println(v.Get("name"))
			fmt.Println(v.Get("friend"))
			fmt.Println(v["friend"])
		}


Package-Level Type Names (total 7, in which 6 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Error (struct)
		Error reports an error and the operation and URL that caused it.

		Fields (total 3, all are exported)
			Err error
			Op string
			URL string
		Methods (total 4, all are exported)
			(*T) Error() string
			(*T) Temporary() bool
			(*T) Timeout() bool
			(*T) Unwrap() error
		Implements (at least 5, in which 2 are exported)
			*T : net.Error
			*T : error
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : net.temporary
			*T : net.timeout
			*T : os.timeout

	 type EscapeError string (basic type)

		Methods (only one, which is exported)
			( T) Error() string
		Implements (at least one exported)
			 T : error

	 type InvalidHostError string (basic type)

		Methods (only one, which is exported)
			( T) Error() string
		Implements (at least one exported)
			 T : error

	 type URL (struct)
		A URL represents a parsed URL (technically, a URI reference).

		The general form represented is:

			[scheme:][//[userinfo@]host][/]path[?query][#fragment]

		URLs 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 URL 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.

		URL's String method uses the EscapedPath method to obtain the path. See the
		EscapedPath method for more details.

		Fields (total 10, all are exported)
			ForceQuery bool
				// append a query ('?') even if RawQuery is empty

			Fragment string
				// fragment for references, without '#'

			Host string
				// host or host:port

			Opaque string
				// encoded opaque data

			Path string
				// path (relative paths may omit leading slash)

			RawFragment string
				// encoded fragment hint (see EscapedFragment method)

			RawPath string
				// encoded path hint (see EscapedPath method)

			RawQuery string
				// encoded query values, without '?'

			Scheme string
			User *Userinfo
				// username and password information

		Methods (total 15, in which 13 are exported)
			(*T) EscapedFragment() string
				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.

			(*T) EscapedPath() string
				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.

			(*T) Hostname() string
				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.

			(*T) IsAbs() bool
				IsAbs reports whether the URL is absolute.
				Absolute means that it has a non-empty scheme.

			(*T) MarshalBinary() (text []byte, err error)
			(*T) Parse(ref string) (*URL, error)
				Parse parses a URL in the context of the receiver. The provided URL
				may be relative or absolute. Parse returns nil, err on parse
				failure, otherwise its return value is the same as ResolveReference.

			(*T) Port() string
				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.

			(*T) Query() Values
				Query parses RawQuery and returns the corresponding values.
				It silently discards malformed value pairs.
				To check errors use ParseQuery.

			(*T) Redacted() string
				Redacted is like String but replaces any password with "xxxxx".
				Only the password in u.URL is redacted.

			(*T) RequestURI() string
				RequestURI returns the encoded path?query or opaque?query
				string that would be used in an HTTP request for u.

			(*T) ResolveReference(ref *URL) *URL
				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
				URL instance, even if the returned URL is identical to either the
				base or reference. If ref is an absolute URL, then ResolveReference
				ignores base and returns a copy of ref.

			(*T) String() string
				String reassembles the URL into a valid URL 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.

			(*T) UnmarshalBinary(text []byte) error
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) setFragment(f string) error
				setFragment is like setPath but for Fragment/RawFragment.

			(*T) setPath(p string) error
				setPath sets the Path and RawPath fields of the URL based on the provided
				escaped path p. It maintains the invariant that RawPath is only specified
				when it differs from the default encoding of the path.
				For example:
				- setPath("/foo/bar")   will set Path="/foo/bar" and RawPath=""
				- setPath("/foo%2fbar") will set Path="/foo/bar" and RawPath="/foo%2fbar"
				setPath will return an error only if the provided path contains an invalid
				escaping.

		Implements (at least 7, in which 4 are exported)
			*T : encoding.BinaryMarshaler
			*T : encoding.BinaryUnmarshaler
			*T : fmt.Stringer
			*T : github.com/neo4j/neo4j-go-driver/v4/neo4j.ServerAddress
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : context.stringer
			*T : crypto/hmac.marshalable
			*T : runtime.stringer
		As Outputs Of (at least 8, in which 5 are exported)
			func Parse(rawurl string) (*URL, error)
			func ParseRequestURI(rawurl string) (*URL, error)
			func (*URL).Parse(ref string) (*URL, error)
			func (*URL).ResolveReference(ref *URL) *URL
			func github.com/neo4j/neo4j-go-driver/v4/neo4j.Driver.Target() URL
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func parse(rawurl string, viaRequest bool) (*URL, error)
			func crypto/x509.parseSANExtension(value []byte) (dnsNames, emailAddresses []string, ipAddresses []net.IP, uris []*URL, err error)
			func github.com/neo4j/neo4j-go-driver/v4/neo4j.newServerAddressURL(hostname string, port string) *URL
		As Inputs Of (at least 4, in which 1 are exported)
			func (*URL).ResolveReference(ref *URL) *URL
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func crypto/x509.marshalSANs(dnsNames, emailAddresses []string, ipAddresses []net.IP, uris []*URL) (derBytes []byte, err error)
			func crypto/x509.matchURIConstraint(uri *URL, constraint string) (bool, error)
			func github.com/neo4j/neo4j-go-driver/v4/neo4j.routingContextFromUrl(useRouting bool, u *URL) (map[string]string, error)

	 type Userinfo (struct)
		The Userinfo type is an immutable encapsulation of username and
		password details for a URL. An existing Userinfo value is guaranteed
		to have a username set (potentially empty, as allowed by RFC 2396),
		and optionally a password.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			password string
			passwordSet bool
			username string
		Methods (total 3, all are exported)
			(*T) Password() (string, bool)
				Password returns the password in case it is set, and whether it is set.

			(*T) String() string
				String returns the encoded userinfo information in the standard form
				of "username[:password]".

			(*T) Username() string
				Username returns the username.

		Implements (at least 3, in which 1 are exported)
			*T : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least 3, in which 2 are exported)
			func User(username string) *Userinfo
			func UserPassword(username, password string) *Userinfo
			/* at least one unexported ... *//* at least one unexported: */
			func parseAuthority(authority string) (user *Userinfo, host string, err error)

	 type Values (map)
		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.

		Methods (total 5, all are exported)
			( T) Add(key, value string)
				Add adds the value to key. It appends to any existing
				values associated with key.

			( T) Del(key string)
				Del deletes the values associated with key.

			( T) Encode() string
				Encode encodes the values into ``URL encoded'' form
				("bar=baz&foo=quux") sorted by key.

			( T) Get(key string) string
				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.

			( T) Set(key, value string)
				Set sets the key to value. It replaces any existing
				values.

		As Outputs Of (at least 2, both are exported)
			func ParseQuery(query string) (Values, error)
			func (*URL).Query() Values
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func parseQuery(m Values, query string) (err error)

	/* one unexported ... *//* one unexported: */
	 type encoding int (basic type)

		As Inputs Of (at least 4, none are exported)
			/* 4+ unexporteds ... *//* 4+ unexporteds: */
			func escape(s string, mode encoding) string
			func shouldEscape(c byte, mode encoding) bool
			func unescape(s string, mode encoding) (string, error)
			func validEncoded(s string, mode encoding) bool
		As Types Of (total 7, none are exported)
			/* 7 unexporteds ... *//* 7 unexporteds: */
			const encodeFragment
			const encodeHost
			const encodePath
			const encodePathSegment
			const encodeQueryComponent
			const encodeUserPassword
			const encodeZone


Package-Level Functions (total 26, in which 9 are exported)

	 func Parse(rawurl string) (*URL, error)
		Parse parses rawurl into a URL structure.

		The rawurl 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 ParseQuery(query string) (Values, error)
		ParseQuery parses the URL-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 or semicolons. A setting without an equals sign is
		interpreted as a key set to an empty value.

	 func ParseRequestURI(rawurl string) (*URL, error)
		ParseRequestURI parses rawurl into a URL structure. It assumes that
		rawurl was received in an HTTP request, so the rawurl is interpreted
		only as an absolute URI or an absolute path.
		The string rawurl is assumed not to have a #fragment suffix.
		(Web browsers strip #fragment before sending the URL to a web server.)

	 func PathEscape(s string) string
		PathEscape escapes the string so it can be safely placed inside a URL path segment,
		replacing special characters (including /) with %XX sequences as needed.

	 func PathUnescape(s string) (string, error)
		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(s string) string
		QueryEscape escapes the string so it can be safely placed
		inside a URL query.

	 func QueryUnescape(s string) (string, error)
		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.

	 func User(username string) *Userinfo
		User returns a Userinfo containing the provided username
		and no password set.

	 func UserPassword(username, password string) *Userinfo
		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.''

	/* 17 unexporteds ... *//* 17 unexporteds: */
	 func escape(s string, mode encoding) string
	 func getscheme(rawurl string) (scheme, path string, err error)
		Maybe rawurl is of the form scheme:path.
		(Scheme must be [a-zA-Z][a-zA-Z0-9+-.]*)
		If so, return scheme, path; else return "", rawurl.

	 func ishex(c byte) bool
	 func parse(rawurl string, viaRequest bool) (*URL, error)
		parse parses a URL from a string in one of two contexts. If
		viaRequest is true, the URL is assumed to have arrived via an HTTP request,
		in which case only absolute URLs or path-absolute relative URLs are allowed.
		If viaRequest is false, all forms of relative URLs are allowed.

	 func parseAuthority(authority string) (user *Userinfo, host string, err error)
	 func parseHost(host string) (string, error)
		parseHost parses host as an authority without user
		information. That is, as host[:port].

	 func parseQuery(m Values, query string) (err error)
	 func resolvePath(base, ref string) string
		resolvePath applies special path segments from refs and applies
		them to base, per RFC 3986.

	 func shouldEscape(c byte, mode encoding) bool
		Return true if the specified character should be escaped when
		appearing in a URL string, according to RFC 3986.

		Please be informed that for now shouldEscape does not check all
		reserved characters correctly. See golang.org/issue/5684.

	 func split(s string, sep byte, cutc bool) (string, string)
		split slices s into two substrings separated by the first occurrence of
		sep. If cutc is true then sep is excluded from the second substring.
		If sep does not occur in s then s and the empty string is returned.

	 func splitHostPort(hostport string) (host, port string)
		splitHostPort separates host and port. If the port is not valid, it returns
		the entire input as host, and it doesn't check the validity of the host.
		Unlike net.SplitHostPort, but per RFC 3986, it requires ports to be numeric.

	 func stringContainsCTLByte(s string) bool
		stringContainsCTLByte reports whether s contains any ASCII control character.

	 func unescape(s string, mode encoding) (string, error)
		unescape unescapes a string; the mode specifies
		which section of the URL string is being unescaped.

	 func unhex(c byte) byte
	 func validEncoded(s string, mode encoding) bool
		validEncoded reports whether s is a valid encoded path or fragment,
		according to mode.
		It must not contain any bytes that require escaping during encoding.

	 func validOptionalPort(port string) bool
		validOptionalPort reports whether port is either an empty string
		or matches /^:\d*$/

	 func validUserinfo(s string) bool
		validUserinfo reports whether s is a valid userinfo string per RFC 3986
		Section 3.2.1:
		    userinfo    = *( unreserved / pct-encoded / sub-delims / ":" )
		    unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
		    sub-delims  = "!" / "$" / "&" / "'" / "(" / ")"
		                  / "*" / "+" / "," / ";" / "="

		It doesn't validate pct-encoded. The caller does that via func unescape.


Package-Level Constants (total 8, none are exported)

	/* 8 unexporteds ... *//* 8 unexporteds: */
	const encodeFragment encoding = 7
	const encodeHost encoding = 3
	const encodePath encoding = 1
	const encodePathSegment encoding = 2
	const encodeQueryComponent encoding = 6
	const encodeUserPassword encoding = 5
	const encodeZone encoding = 4
	const upperhex = "0123456789ABCDEF"

The pages are generated with Golds v0.4.2. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.