httplib

package
v1.26.27 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 31, 2026 License: MIT Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var RequestContextKey = RequestContextKeyStruct{}

Functions

func DialContextWithTimeout

func DialContextWithTimeout(timeout time.Duration) func(ctx context.Context, network, address string) (net.Conn, error)

func EncodeContentDispositionAttachment

func EncodeContentDispositionAttachment(filename string) string

func EncodeContentDispositionInline

func EncodeContentDispositionInline(filename string) string

func GuessCurrentAppURL

func GuessCurrentAppURL(ctx context.Context) string

GuessCurrentAppURL tries to guess the current full public URL (with sub-path) by http headers. It always has a '/' suffix, exactly the same as setting.AppURL TODO: should rename it to GuessCurrentPublicURL in the future

func GuessCurrentHostDomain

func GuessCurrentHostDomain(ctx context.Context) string

func GuessCurrentHostURL

func GuessCurrentHostURL(ctx context.Context) string

GuessCurrentHostURL tries to guess the current full host URL (no sub-path) by http headers, there is no trailing slash.

func IsCurrentGitSiteURL added in v1.26.27

func IsCurrentGitSiteURL(ctx context.Context, s string) bool

func IsRelativeURL

func IsRelativeURL(s string) bool

IsRelativeURL detects if a URL is relative (no scheme or host)

func MakeAbsoluteURL

func MakeAbsoluteURL(ctx context.Context, link string) string

MakeAbsoluteURL tries to make a link to an absolute public URL: * If link is empty, it returns the current public URL. * If link is absolute, it returns the link. * Otherwise, it returns the current host URL + link, the link itself should have correct sub-path (AppSubURL) if needed.

func ServeSetHeaders

func ServeSetHeaders(w http.ResponseWriter, opts ServeHeaderOptions)

ServeSetHeaders sets necessary content serve headers

func ServeUserContentByFile

func ServeUserContentByFile(r *http.Request, w http.ResponseWriter, file fs.File, opts ServeHeaderOptions)

func ServeUserContentByReader

func ServeUserContentByReader(r *http.Request, w http.ResponseWriter, size int64, reader io.Reader, opts ServeHeaderOptions)

Types

type ContentDispositionType

type ContentDispositionType string
const (
	ContentDispositionInline     ContentDispositionType = "inline"
	ContentDispositionAttachment ContentDispositionType = "attachment"
)

type GitSiteURL added in v1.26.27

type GitSiteURL struct {
	RoutePath   string
	OwnerName   string
	RepoName    string
	RepoSubPath string
}

func ParseGitSiteURL added in v1.26.27

func ParseGitSiteURL(ctx context.Context, s string) *GitSiteURL

type Request

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

func NewRequest

func NewRequest(url, method string) *Request

func (*Request) Body

func (r *Request) Body(data any) *Request

Body adds request raw body. It supports string, []byte and io.Reader as body.

func (*Request) GoString

func (r *Request) GoString() string

func (*Request) Header

func (r *Request) Header(key, value string) *Request

Header set header item string in request.

func (*Request) Param

func (r *Request) Param(key, value string) *Request

Param adds query param in to request. params build query string as ?key1=value1&key2=value2...

func (*Request) Response

func (r *Request) Response() (*http.Response, error)

Response executes request client and returns the response. Caller MUST close the response body if no error occurs.

func (*Request) SetContext

func (r *Request) SetContext(ctx context.Context) *Request

SetContext sets the request's Context

func (*Request) SetReadWriteTimeout

func (r *Request) SetReadWriteTimeout(readWriteTimeout time.Duration) *Request

func (*Request) SetTransport

func (r *Request) SetTransport(transport http.RoundTripper) *Request

SetTransport sets the request transport, if not set, will use httplib's default transport with environment proxy support ATTENTION: the http.Transport has a connection pool, so it should be reused as much as possible, do not create a lot of transports

type RequestContextKeyStruct

type RequestContextKeyStruct struct{}

type ServeHeaderOptions

type ServeHeaderOptions struct {
	ContentType   string // defaults to "application/octet-stream"
	ContentLength *int64

	Filename           string
	ContentDisposition ContentDispositionType

	CacheIsPublic bool
	CacheDuration time.Duration // defaults to 5 minutes
	LastModified  time.Time
}

Jump to

Keyboard shortcuts

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