proxy

Documentation

Index

• type URL
  • func MustNewURL(u string) *URL
  • func (u *URL) GetURL() *url.URL
  • func (u *URL) IsHTTPOrHTTPS() bool
  • func (u *URL) MarshalJSON() ([]byte, error)
  • func (u *URL) MarshalYAML() (any, error)
  • func (u *URL) NewDialFunc(ac *promauth.Config) (func(ctx context.Context, network, addr string) (net.Conn, error), error)
  • func (u *URL) SetHeaders(ac *promauth.Config, req *http.Request) error
  • func (u *URL) String() string
  • func (u *URL) UnmarshalJSON(b []byte) error
  • func (u *URL) UnmarshalYAML(unmarshal func(any) error) error

Types

type URL

type URL struct {
	URL *url.URL
}

URL implements YAML.Marshaler and yaml.Unmarshaler interfaces for url.URL.

func MustNewURL

func MustNewURL(u string) *URL

MustNewURL returns new URL for the given u.

func (*URL) GetURL

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

GetURL return the underlying url.

func (*URL) IsHTTPOrHTTPS

func (u *URL) IsHTTPOrHTTPS() bool

IsHTTPOrHTTPS returns true if u is http or https

func (*URL) MarshalJSON

func (u *URL) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshal interface. required to properly clone internal representation of url

func (*URL) MarshalYAML

func (u *URL) MarshalYAML() (any, error)

MarshalYAML implements yaml.Marshaler interface.

func (*URL) NewDialFunc

func (u *URL) NewDialFunc(ac *promauth.Config) (func(ctx context.Context, network, addr string) (net.Conn, error), error)

NewDialFunc returns dial func for the given u and ac. Dial uses HTTP CONNECT for http and https targets https://en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_method And socks5 for socks5 targets https://en.wikipedia.org/wiki/SOCKS supports authorization and tls configuration

func (*URL) SetHeaders

func (u *URL) SetHeaders(ac *promauth.Config, req *http.Request) error

SetHeaders sets headers to req according to u and ac configs.

func (*URL) String

func (u *URL) String() string

String returns string representation of u.

func (*URL) UnmarshalJSON

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

UnmarshalJSON implements json.Unmarshaller interface. required to properly clone internal representation of url

func (*URL) UnmarshalYAML

func (u *URL) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.