options

package

Go to main page

Versions in this module

v2

v2.2.0

Feb 2, 2026

Changes in this version

type Option

+ Context context.Context

+ MaxResponseHeaderBytes int64

+ Protocol Protocol

+ func (opt *Option) SetContext(ctx context.Context) *Option

+ func (opt *Option) SetMaxResponseHeaderBytes(size int64) *Option

+ func (opt *Option) SetProgressTracking(pt ProgressTracking) *Option

+ func (opt *Option) SetProtocol(p Protocol) *Option

+ func (opt *Option) SetUploadBufferSize(size int)

+ type Protocol int

+ const Both

+ const HTTP1

+ const HTTP2

+ const UnencryptedHTTP2

v2.1.1

Feb 5, 2025

v2.1.0

Feb 3, 2025

Changes in this version

+ func NewProgressWriter(w io.Writer, totalSize int64, onProgress func(current, total int64)) io.Writer

type Option

+ CustomDecompressor func(r io.Reader) (io.Reader, error)

+ func (opt *Option) GetDecompressor(r io.ReadCloser, encoding string) (io.ReadCloser, error)

+ func (opt *Option) GetProgressTracking() ProgressTracking

+ func (opt *Option) TrackAfterCompression() *Option

+ func (opt *Option) TrackBeforeCompression() *Option

+ func (opt *Option) UsePerRequestClient()

+ func (opt *Option) UseSharedClient()

+ type ProgressTracking int

+ const TrackAfterCompression

+ const TrackBeforeCompression

type UniqueIdentifierType

+ const IdentifierRGS

v2.0.2

Jan 22, 2025

v2.0.1

Jan 22, 2025

v2.0.0

Jan 22, 2025

Changes in this version

+ var ErrInvalidCompression = errors.New("unsupported compression type")

+ var ErrInvalidWriterType = errors.New("invalid writer type")

+ var ErrMissingFilePath = errors.New("file path must be specified when using WriteToFile")

+ var ErrUnexpectedFilePath = errors.New("filepath should not be provided when using WriteToBuffer")

+ func ProgressWriter(writer io.WriteCloser, total int64, onProgress func(written, total int64)) *progressWriter

+ type CompressionType string

+ const CompressionBrotli

+ const CompressionCustom

+ const CompressionDeflate

+ const CompressionGzip

+ const CompressionNone

+ type Option struct

+ Compression CompressionType

+ Cookies []*http.Cookie

+ CustomCompressionType CompressionType

+ CustomCompressor func(w *io.PipeWriter) (io.WriteCloser, error)

+ DownloadBufferSize *int

+ FollowRedirects bool

+ Header http.Header

+ Logger slog.Logger

+ MaxRedirects int

+ OnDownloadProgress func(bytesRead, totalBytes int64)

+ OnUploadProgress func(bytesRead, totalBytes int64)

+ PreserveMethodOnRedirect bool

+ ProtocolScheme string

+ ResponseWriter ResponseWriter

+ Transport *http.Transport

+ UniqueIdentifierType UniqueIdentifierType

+ UploadBufferSize *int

+ UserAgent string

+ Verbose bool

+ func New(opts ...*Option) *Option

+ func (o *Option) GetClient() *http.Client

+ func (opt *Option) AddCookie(cookie *http.Cookie)

+ func (opt *Option) AddHeader(key string, value string)

+ func (opt *Option) CheckRedirects() bool

+ func (opt *Option) ClearCookies()

+ func (opt *Option) ClearHeaders()

+ func (opt *Option) CloseFile() error

+ func (opt *Option) CreatePayloadReader(payload any) (io.Reader, int64, error)

+ func (opt *Option) DisableLogging()

+ func (opt *Option) DisablePreserveMethodOnRedirect()

+ func (opt *Option) DisableRedirects()

+ func (opt *Option) EnableLogging()

+ func (opt *Option) EnablePreserveMethodOnRedirect()

+ func (opt *Option) EnableRedirects()

+ func (opt *Option) Filesize() int64

+ func (opt *Option) GenerateIdentifier() string

+ func (opt *Option) GetCompressor(w *io.PipeWriter) (io.WriteCloser, error)

+ func (opt *Option) GetFile() *os.File

+ func (opt *Option) GetMaxRedirects() int

+ func (opt *Option) GetWriter() io.WriteCloser

+ func (opt *Option) HasFileHandle() bool

+ func (opt *Option) InferContentType(file *os.File, fileInfo os.FileInfo) error

+ func (opt *Option) InitialiseWriter() (io.WriteCloser, error)

+ func (opt *Option) Log(msg string, args ...any)

+ func (opt *Option) Merge(src *Option)

+ func (opt *Option) PrepareFile(filename string) error

+ func (opt *Option) Redirects(enabled bool, preserve bool)

+ func (opt *Option) ReopenFile() (*os.File, error)

+ func (opt *Option) SetBufferOutput()

+ func (opt *Option) SetClient(client *http.Client)

+ func (opt *Option) SetCompression(compressionType CompressionType)

+ func (opt *Option) SetDownloadBufferSize(size int)

+ func (opt *Option) SetFile(file *os.File)

+ func (opt *Option) SetFileOutput(filepath string)

+ func (opt *Option) SetLogger(logger *slog.Logger)

+ func (opt *Option) SetMaxRedirects(size int)

+ func (opt *Option) SetOutput(writerType ResponseWriterType, filepath ...string) error

+ func (opt *Option) SetProtocolScheme(scheme string)

+ func (opt *Option) SetTransport(transport *http.Transport)

+ func (opt *Option) UseJsonLogger()

+ func (opt *Option) UseTextLogger()

+ type ProgressReader struct

+ func NewProgressReader(reader io.Reader, total int64, onProgress func(read, total int64)) *ProgressReader

+ func (pr *ProgressReader) CloneForRedirect() *ProgressReader

+ func (pr *ProgressReader) GetProgress() int64

+ func (pr *ProgressReader) Read(p []byte) (int, error)

+ type ResponseWriter struct

+ FilePath string

+ Type ResponseWriterType

+ type ResponseWriterType string

+ const WriteToBuffer

+ const WriteToFile

+ type UniqueIdentifierType string

+ const IdentifierNone

+ const IdentifierULID

+ const IdentifierUUID

+ type WriteCloserBuffer struct

+ func (w *WriteCloserBuffer) IsEmpty() bool

+ func (wcb *WriteCloserBuffer) Close() error

Other modules containing this package

github.com/caelisco/http-client

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL