url

Documentation

Overview

package url provides url fuctionalities to provide consistent parsing for Kwil clients.

Index

• Variables
• func HasScheme(u string) (bool, error)
• type Scheme
  • func (s Scheme) String() string
  • func (s Scheme) Valid() bool
• type URL
  • func ParseURL(u string) (*URL, error)
  • func ParseURLWithDefaultScheme(u, defaultScheme string) (*URL, error)
  • func (u *URL) URL() *url.URL

Variables

var (
	ErrUnknownScheme = errors.New("unknown scheme")
)

Functions

func HasScheme

func HasScheme(u string) (bool, error)

hasScheme returns true if the url has a known scheme.

Types

type Scheme

type Scheme string

Scheme is a protocol scheme, such as http or tcp.

const (
	HTTP  Scheme = "http"
	HTTPS Scheme = "https"
	TCP   Scheme = "tcp"
	UNIX  Scheme = "unix"
)

func (Scheme) String

func (s Scheme) String() string

func (Scheme) Valid

func (s Scheme) Valid() bool

type URL

type URL struct {
	// Original is the original URL string.
	Original string
	// Scheme is the protocol scheme, such as http or tcp.
	Scheme Scheme
	// Target is either the host, host:port, or unix socket path.
	Target string
	// Port is the port number, or 0 if not specified.
	Port int
	// contains filtered or unexported fields
}

URL is a parsed URL.

func ParseURL

func ParseURL(u string) (*URL, error)

ParseURL parses a URL string into a URL struct. URLs can be of the form: - http://localhost:8080 - tcp://localhost:8080 - localhost:8080 - localhost - unix:///var/run/kwil.sock If the URL does not have a scheme, it is assumed to be a tcp address. If it does not have a port, it is set to 0. This is only appropriate for listen addresses.

func ParseURLWithDefaultScheme

func ParseURLWithDefaultScheme(u, defaultScheme string) (*URL, error)

ParseURLWithDefaultScheme is like ParseURL, but the default scheme may be specified. If empty, "tcp://" is used.

func (*URL) URL

func (u *URL) URL() *url.URL

URL returns the parsed url.URL.