endpoint

Documentation

Index

• Constants
• Variables
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
• type Provider
  • func Parse(cfg string) (p Provider, err error)
• type Static
  • func NewHTTP(host string, port int) Static
  • func NewHTTPS(host string, port int) Static
  • func (s Static) Value() Value
• type Value
  • func (v Value) String() string

Constants

const (
	// ProtocolHTTPS is the https credential protocol.
	ProtocolHTTPS = "https"
	// ProtocolHTTP is the http credential protocol.
	ProtocolHTTP = "http"
)

Variables

var (
	// ErrUnsupportedProtocol will return if protocol is unsupported.
	ErrUnsupportedProtocol = errors.New("unsupported protocol")
	// ErrInvalidValue means value is invalid.
	ErrInvalidValue = errors.New("invalid value")
)

Types

type Error

type Error struct {
	Op  string
	Err error

	Protocol string
	Values   []string
}

Error represents error related to endpoint.

func (*Error) Error

func (e *Error) Error() string

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap implements xerrors.Wrapper

type Provider

type Provider interface {
	Value() Value
}

Provider will return all info needed to connect a service.

func Parse

func Parse(cfg string) (p Provider, err error)

Parse will parse config string to create a endpoint Provider.

type Static

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

Static is the static endpoint.

func NewHTTP

func NewHTTP(host string, port int) Static

NewHTTP will create a static endpoint from parsed URL.

func NewHTTPS

func NewHTTPS(host string, port int) Static

NewHTTPS will create a static endpoint from parsed URL.

func (Static) Value

func (s Static) Value() Value

Value implements Provider interface.

type Value

type Value struct {
	Protocol string
	Host     string
	Port     int
}

Value is the required info to connect a service.

func (Value) String

func (v Value) String() string

String will compose all info into a valid URL.