rest

Documentation

Index

• Variables
• type Client
  • func NewClient(endpoint string) (*Client, error)
• type Conf
  • func (*Conf) Descriptor() ([]byte, []int)
  • func (x *Conf) GetAddress() string
  • func (x *Conf) GetNetwork() string
  • func (x *Conf) GetTimeout() *durationpb.Duration
  • func (*Conf) ProtoMessage()
  • func (x *Conf) ProtoReflect() protoreflect.Message
  • func (x *Conf) Reset()
  • func (x *Conf) String() string
  • func (m *Conf) Validate() error
  • func (m *Conf) ValidateAll() error
• type ConfMultiError
  • func (m ConfMultiError) AllErrors() []error
  • func (m ConfMultiError) Error() string
• type ConfValidationError
  • func (e ConfValidationError) Cause() error
  • func (e ConfValidationError) Error() string
  • func (e ConfValidationError) ErrorName() string
  • func (e ConfValidationError) Field() string
  • func (e ConfValidationError) Key() bool
  • func (e ConfValidationError) Reason() string
• type Option
  • func WithFilter(m ...http.FilterFunc) Option
  • func WithMiddleware(m ...middleware.Middleware) Option
• type Server
  • func NewServer(c *Conf, opts ...Option) *Server

Variables

var File_rest_conf_proto protoreflect.FileDescriptor

Types

type Client

type Client = http.Client

func NewClient

func NewClient(endpoint string) (*Client, error)

type Conf

type Conf struct {
	Network string               `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
	Address string               `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	Timeout *durationpb.Duration `protobuf:"bytes,3,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

func (*Conf) Descriptor

func (*Conf) Descriptor() ([]byte, []int)

Deprecated: Use Conf.ProtoReflect.Descriptor instead.

func (*Conf) GetAddress

func (x *Conf) GetAddress() string

func (*Conf) GetNetwork

func (x *Conf) GetNetwork() string

func (*Conf) GetTimeout

func (x *Conf) GetTimeout() *durationpb.Duration

func (*Conf) ProtoMessage

func (*Conf) ProtoMessage()

func (*Conf) ProtoReflect

func (x *Conf) ProtoReflect() protoreflect.Message

func (*Conf) Reset

func (x *Conf) Reset()

func (*Conf) String

func (x *Conf) String() string

func (*Conf) Validate

func (m *Conf) Validate() error

Validate checks the field values on Conf with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Conf) ValidateAll

func (m *Conf) ValidateAll() error

ValidateAll checks the field values on Conf with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ConfMultiError, or nil if none found.

type ConfMultiError

type ConfMultiError []error

ConfMultiError is an error wrapping multiple validation errors returned by Conf.ValidateAll() if the designated constraints aren't met.

func (ConfMultiError) AllErrors

func (m ConfMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ConfMultiError) Error

func (m ConfMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ConfValidationError

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

ConfValidationError is the validation error returned by Conf.Validate if the designated constraints aren't met.

func (ConfValidationError) Cause

func (e ConfValidationError) Cause() error

Cause function returns cause value.

func (ConfValidationError) Error

func (e ConfValidationError) Error() string

Error satisfies the builtin error interface

func (ConfValidationError) ErrorName

func (e ConfValidationError) ErrorName() string

ErrorName returns error name.

func (ConfValidationError) Field

func (e ConfValidationError) Field() string

Field function returns field value.

func (ConfValidationError) Key

func (e ConfValidationError) Key() bool

Key function returns key value.

func (ConfValidationError) Reason

func (e ConfValidationError) Reason() string

Reason function returns reason value.

type Option

type Option func(*options)

func WithFilter

func WithFilter(m ...http.FilterFunc) Option

func WithMiddleware

func WithMiddleware(m ...middleware.Middleware) Option

WithMiddleware with sys client

type Server

type Server = http.Server

func NewServer

func NewServer(c *Conf, opts ...Option) *Server

NewServer new a HTTP server.