xhttp

Documentation

Index

• Constants
• Variables
• func AsMaxBytesError(err error) *http.MaxBytesError
• func MaxBytesReader(r io.Reader, n int64) *maxBytesReader
• func NewSniffReadCloser(r io.ReadCloser) *sniffReadCloser
• func ParseHTTPRequest[T any](req *http.Request) (*T, error)
• func ParseHTTPRequestWithLimitedSize[T any](req *http.Request, limitedSize int64) (*T, error)
• func ParseURL(s string) (*url.URL, error)
• func WriteResponseJSON(w http.ResponseWriter, code int, obj any) error
• type File
  • func NewFile(body SniffReadCloser, r *http.Request) *File
  • func NewFileFromMultipartFile(f multipart.File, header *multipart.FileHeader) *File
  • func (f *File) AsBytes() (*bytes.Reader, error)
  • func (f *File) AsFile() (io.ReadSeeker, error)
  • func (f *File) Close() error
  • func (f *File) ContentLength() int
  • func (f *File) ContentType(nsniff int64) (string, error)
  • func (f *File) Reader() (io.Reader, error)
  • func (f *File) SetMaxSize(s int64)
• type FormDataRequest
• type SniffReadCloser
• type Sniffer

Constants

const DefaultMaxFileSize = 100 * xbytes.MiB

const DefaultMaxInMemoryMultipartSize = 10 * xbytes.MiB // 10MiB

Variables

var (
	ErrHTTPBadRequest = errors.New("")
	ErrHTTPTooLarge   = errors.New("")
)

var DiscardMemory = 512 * xbytes.KiB

var MaxInMemoryMultipartSize = DefaultMaxInMemoryMultipartSize

Functions

func AsMaxBytesError

func AsMaxBytesError(err error) *http.MaxBytesError

func MaxBytesReader

func MaxBytesReader(r io.Reader, n int64) *maxBytesReader

MaxBytesReader is similar to http.MaxBytesReader but supporting for io.Reader instead of io.ReadCloser. It also doesn't support writing to any Writer when a MaxBytesError occurs.

func NewSniffReadCloser

func NewSniffReadCloser(r io.ReadCloser) *sniffReadCloser

func ParseHTTPRequest

func ParseHTTPRequest[T any](req *http.Request) (*T, error)

func ParseHTTPRequestWithLimitedSize

func ParseHTTPRequestWithLimitedSize[T any](req *http.Request, limitedSize int64) (*T, error)

func ParseURL

func ParseURL(s string) (*url.URL, error)

func WriteResponseJSON

func WriteResponseJSON(w http.ResponseWriter, code int, obj any) error

Types

type File

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

func NewFile

func NewFile(body SniffReadCloser, r *http.Request) *File

func NewFileFromMultipartFile

func NewFileFromMultipartFile(f multipart.File, header *multipart.FileHeader) *File

func (*File) AsBytes

func (f *File) AsBytes() (*bytes.Reader, error)

AsBytes converts File to bytes.Reader. It saves total file content into memory and suitable for small files.

func (*File) AsFile

func (f *File) AsFile() (io.ReadSeeker, error)

AsFile converts File to a ReadSeeker. The total file content is saved into a temporary file. It's suitable for large files.

func (*File) Close

func (f *File) Close() error

func (*File) ContentLength

func (f *File) ContentLength() int

func (*File) ContentType

func (f *File) ContentType(nsniff int64) (string, error)

func (*File) Reader

func (f *File) Reader() (io.Reader, error)

func (*File) SetMaxSize

func (f *File) SetMaxSize(s int64)

type FormDataRequest

type FormDataRequest interface {
	NumFiles() int
}

type SniffReadCloser

type SniffReadCloser interface {
	io.ReadCloser
	Sniffer
}

type Sniffer

type Sniffer interface {
	// Sniff is similar to Read but does not change the cursor.
	Sniff([]byte) (int, error)
}