uri

Documentation

Index

• Variables
• type Uri
  • func NewFromFasthttpUri(furi *fasthttp.URI) (Uri, error)
  • func Parse(uriStr string) (Uri, error)
  • func ParseBytes(uri []byte) (Uri, error)
  • func (u *Uri) Hash() string
  • func (u *Uri) Host() string
  • func (u *Uri) HostName() string
  • func (u *Uri) IsValid() bool
  • func (u Uri) MarshalJSON() ([]byte, error)
  • func (u *Uri) Origin() string
  • func (u *Uri) Path() string
  • func (u *Uri) QueryString() string
  • func (u *Uri) RootUri() Uri
  • func (u *Uri) Scan(src any) error
  • func (u *Uri) Scheme() string
  • func (u Uri) String() string
  • func (u *Uri) UnmarshalJSON(b []byte) error
  • func (u *Uri) Value() (driver.Value, error)

Variables

var ErrUriIsRelative = errors.New("uri is relative")

Types

type Uri

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

Uri define a read-only absolute URI object.

func NewFromFasthttpUri

func NewFromFasthttpUri(furi *fasthttp.URI) (Uri, error)

NewFromFasthttpUri returns a new URI from the given URI. This function panics if the given *fasthttp.URI is nil.

func Parse

func Parse(uriStr string) (Uri, error)

Parse parses an absolute URI and normalize it.

func ParseBytes

func ParseBytes(uri []byte) (Uri, error)

ParseBytes parses an URI and normalize it.

func (*Uri) Hash

func (u *Uri) Hash() string

Hash returns hash of URI: bang for https://www.example.com:8080/foo/bar?q=baz#bang

func (*Uri) Host

func (u *Uri) Host() string

Host returns host of URI: www.example.com:8080 for https://www.example.com:8080/foo/bar?q=baz#bang

func (*Uri) HostName

func (u *Uri) HostName() string

HostName returns hostname of URI: www.example.com for https://www.example.com:8080/foo/bar?q=baz#bang

func (*Uri) IsValid

func (u *Uri) IsValid() bool

IsValid returns true if data was successfully parsed.

func (Uri) MarshalJSON

func (u Uri) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*Uri) Origin

func (u *Uri) Origin() string

Origin returns origin part of Uri.

func (*Uri) Path

func (u *Uri) Path() string

Path returns normalized path of URI: /foo/bar for https://www.example.com:8080/foo/bar?q=baz#bang

func (*Uri) QueryString

func (u *Uri) QueryString() string

QueryBytes returns extracted query bytes (extractQuery must be true when calling Parse / ParseBytes): q=baz for https://www.example.com:8080/foo/bar?q=baz#bang

func (*Uri) RootUri

func (u *Uri) RootUri() Uri

RootUri returns a new Uri with path stripped to / and query args and fragment removed.

func (*Uri) Scan

func (u *Uri) Scan(src any) error

Scan implements sql.Scanner.

func (*Uri) Scheme

func (u *Uri) Scheme() string

Scheme returns scheme of URI: https for https://www.example.com:8080/foo/bar?q=baz#bang

func (Uri) String

func (u Uri) String() string

String implements fmt.Stringer.

func (*Uri) UnmarshalJSON

func (u *Uri) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

func (*Uri) Value

func (u *Uri) Value() (driver.Value, error)

Value implements driver.Valuer.