path

Documentation

Overview

Package path defines helpers for constructing Charmhub API URL paths.

Index

• type Path
  • func MakePath(base *url.URL) Path
  • func (u Path) Join(names ...string) (Path, error)
  • func (u Path) Query(key string, value string) (Path, error)
  • func (u Path) String() string

Types

type Path

type Path struct {
	// contains filtered or unexported fields
}

Path defines a absolute path for calling requests to the server.

func MakePath

func MakePath(base *url.URL) Path

MakePath creates a URL for queries to a server.

func (Path) Join

func (u Path) Join(names ...string) (Path, error)

Join will sum path names onto a base URL and ensure it constructs a URL that is valid. Example:

• http://baseurl/name0/name1/

func (Path) Query

func (u Path) Query(key string, value string) (Path, error)

Query adds additional query parameters to the Path. Example:

• http://baseurl/name0/name1?q=value

func (Path) String

func (u Path) String() string

String returns a stringified version of the Path. Under the hood this calls the url.URL#String method.