uri

README

uri

Package uri is an implementation of the URI Uniform Resource Identifier(RFC3986) specification for Go.

Documentation

Overview

Package uri is an implementation of the URI Uniform Resource Identifier(RFC3986) specification for Go.

Index

• Constants
• type URI
  • func File(path string) URI
  • func From(scheme, authority, path, query, fragment string) URI
  • func New(s string) URI
  • func Parse(s string) (u URI, err error)
  • func (u URI) Filename() string

Constants

const (
	// FileScheme schema of filesystem path.
	FileScheme = "file"

	// HTTPScheme schema of http.
	HTTPScheme = "http"

	// HTTPSScheme schema of https.
	HTTPSScheme = "https"
)

Types

type URI

type URI string

URI Uniform Resource Identifier (URI) https://tools.ietf.org/html/rfc3986.

This class is a simple parser which creates the basic component parts (http://tools.ietf.org/html/rfc3986#section-3) with minimal validation and encoding.

  foo://example.com:8042/over/there?name=ferret#nose
  \_/   \______________/\_________/ \_________/ \__/
   |           |            |            |        |
scheme     authority       path        query   fragment
   |   _____________________|__
  / \ /                        \
  urn:example:animal:ferret:nose

func File

func File(path string) URI

File parses and creates a new filesystem URI from path.

func From

func From(scheme, authority, path, query, fragment string) URI

From returns the new URI from args.

func New

func New(s string) URI

New parses and creates a new URI from s.

func Parse

func Parse(s string) (u URI, err error)

Parse parses and creates a new URI from s.

func (URI) Filename

func (u URI) Filename() string

Filename returns the file path for the given URI. It is an error to call this on a URI that is not a valid filename.