rettypes

Documentation

Index

• type Html
  • func HtmlView(root fs.FS, name string, data any) *Html
  • func NewHtml(tpl string, data any) *Html
  • func (h *Html) ContentType() string
  • func (h *Html) Register() []reflect.Type
  • func (h *Html) Return() io.Reader
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func NewReaderWithContext(r io.Reader, ctx context.Context) *Reader
  • func (s *Reader) Read(p []byte) (int, error)
  • func (s *Reader) SetRateLimit(bytesPerSec float64)
• type Redirect
  • func NewRedirect(location string) *Redirect
  • func (r *Redirect) Append(header def.ReadHeader) map[string]string
  • func (r *Redirect) Code() int
  • func (r *Redirect) ContentType() string
  • func (r *Redirect) Register() []reflect.Type
  • func (r *Redirect) Return() io.Reader
• type Resp
  • func NewResp(resp any) *Resp
  • func (r *Resp) Append(header def.ReadHeader) map[string]string
  • func (r *Resp) Code() int
  • func (r *Resp) ContentType() string
  • func (r *Resp) Register() []reflect.Type
  • func (r *Resp) Return() io.Reader
  • func (r *Resp) SetCode(code int) *Resp
  • func (r *Resp) SetContentType(contentType string) *Resp
  • func (r *Resp) SetHeader(header map[string]string) *Resp
  • func (r *Resp) SetReader(reader io.Reader) *Resp
  • func (r *Resp) SetSerialize(serialize def.Serialize) *Resp
• type Stream
  • func NewStream(io io.Reader) *Stream
  • func (s *Stream) AddHeader(k, v string)
  • func (s *Stream) Append(header def.ReadHeader) map[string]string
  • func (s *Stream) Close() error
  • func (s *Stream) Code() int
  • func (s *Stream) ContentType() string
  • func (s *Stream) Read(p []byte) (n int, err error)
  • func (s *Stream) Register() []reflect.Type
  • func (s *Stream) Return() io.Reader
  • func (s *Stream) SetContentType(conTyp string)
  • func (s *Stream) SetName(name string) *Stream
  • func (s *Stream) SetRateLimit(bytesPerSec float64) *Stream
  • func (s *Stream) Strings() string
• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func NewWriterWithContext(w io.Writer, ctx context.Context) *Writer
  • func (s *Writer) SetRateLimit(bytesPerSec float64)
  • func (s *Writer) Write(p []byte) (int, error)

Types

type Html

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

func HtmlView

func HtmlView(root fs.FS, name string, data any) *Html

func NewHtml

func NewHtml(tpl string, data any) *Html

func (*Html) ContentType

func (h *Html) ContentType() string

func (*Html) Register

func (h *Html) Register() []reflect.Type

func (*Html) Return

func (h *Html) Return() io.Reader

type Reader

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

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns a reader that implements io.Reader with rate limiting.

func NewReaderWithContext

func NewReaderWithContext(r io.Reader, ctx context.Context) *Reader

NewReaderWithContext returns a reader that implements io.Reader with rate limiting.

func (*Reader) Read

func (s *Reader) Read(p []byte) (int, error)

Read reads bytes into p.

func (*Reader) SetRateLimit

func (s *Reader) SetRateLimit(bytesPerSec float64)

SetRateLimit sets rate limit (bytes/sec) to the reader.

type Redirect

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

func NewRedirect

func NewRedirect(location string) *Redirect

func (*Redirect) Append

func (r *Redirect) Append(header def.ReadHeader) map[string]string

func (*Redirect) Code

func (r *Redirect) Code() int

func (*Redirect) ContentType

func (r *Redirect) ContentType() string

func (*Redirect) Register

func (r *Redirect) Register() []reflect.Type

func (*Redirect) Return

func (r *Redirect) Return() io.Reader

type Resp

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

func NewResp

func NewResp(resp any) *Resp

func (*Resp) Append

func (r *Resp) Append(header def.ReadHeader) map[string]string

Append implements def.AppendHeader. ReadOnly

func (*Resp) Code

func (r *Resp) Code() int

Code implements def.HttpStatus. ReadOnly

func (*Resp) ContentType

func (r *Resp) ContentType() string

ContentType implements def.RetAdapter. ReadOnly

func (*Resp) Register

func (r *Resp) Register() []reflect.Type

Register implements def.RetAdapter. ReadOnly

func (*Resp) Return

func (r *Resp) Return() io.Reader

Return implements def.RetAdapter. ReadOnly

func (*Resp) SetCode

func (r *Resp) SetCode(code int) *Resp

func (*Resp) SetContentType

func (r *Resp) SetContentType(contentType string) *Resp

func (*Resp) SetHeader

func (r *Resp) SetHeader(header map[string]string) *Resp

func (*Resp) SetReader

func (r *Resp) SetReader(reader io.Reader) *Resp

func (*Resp) SetSerialize

func (r *Resp) SetSerialize(serialize def.Serialize) *Resp

type Stream

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

func NewStream

func NewStream(io io.Reader) *Stream

func (*Stream) AddHeader

func (s *Stream) AddHeader(k, v string)

func (*Stream) Append

func (s *Stream) Append(header def.ReadHeader) map[string]string

func (*Stream) Close

func (s *Stream) Close() error

func (*Stream) Code

func (s *Stream) Code() int

func (*Stream) ContentType

func (s *Stream) ContentType() string

func (*Stream) Read

func (s *Stream) Read(p []byte) (n int, err error)

Read(p []byte) (n int, err error)

func (*Stream) Register

func (s *Stream) Register() []reflect.Type

func (*Stream) Return

func (s *Stream) Return() io.Reader

func (*Stream) SetContentType

func (s *Stream) SetContentType(conTyp string)

func (*Stream) SetName

func (s *Stream) SetName(name string) *Stream

func (*Stream) SetRateLimit

func (s *Stream) SetRateLimit(bytesPerSec float64) *Stream

func (*Stream) Strings

func (s *Stream) Strings() string

type Writer

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

func NewWriter

func NewWriter(w io.Writer) *Writer

NewWriter returns a writer that implements io.Writer with rate limiting.

func NewWriterWithContext

func NewWriterWithContext(w io.Writer, ctx context.Context) *Writer

NewWriterWithContext returns a writer that implements io.Writer with rate limiting.

func (*Writer) SetRateLimit

func (s *Writer) SetRateLimit(bytesPerSec float64)

SetRateLimit sets rate limit (bytes/sec) to the writer.

func (*Writer) Write

func (s *Writer) Write(p []byte) (int, error)

Write writes bytes from p.