Documentation
¶
Index ¶
- Variables
- func DialContextWithTimeout(timeout time.Duration) func(ctx context.Context, network, address string) (net.Conn, error)
- func GuessCurrentAppURL(ctx context.Context) string
- func GuessCurrentHostDomain(ctx context.Context) string
- func GuessCurrentHostURL(ctx context.Context) string
- func IsCurrentGiteaSiteURL(ctx context.Context, s string) bool
- func IsRelativeURL(s string) bool
- func MakeAbsoluteURL(ctx context.Context, link string) string
- func ServeContentByReadSeeker(r *http.Request, w http.ResponseWriter, modTime *time.Time, ...)
- func ServeContentByReader(r *http.Request, w http.ResponseWriter, size int64, reader io.Reader, ...)
- func ServeSetHeaders(w http.ResponseWriter, opts *ServeHeaderOptions)
- type GiteaSiteURL
- type Request
- func (r *Request) Body(data any) *Request
- func (r *Request) GoString() string
- func (r *Request) Header(key, value string) *Request
- func (r *Request) Param(key, value string) *Request
- func (r *Request) Response() (*http.Response, error)
- func (r *Request) SetContext(ctx context.Context) *Request
- func (r *Request) SetReadWriteTimeout(readWriteTimeout time.Duration) *Request
- func (r *Request) SetTransport(transport http.RoundTripper) *Request
- type RequestContextKeyStruct
- type ServeHeaderOptions
Constants ¶
This section is empty.
Variables ¶
var RequestContextKey = RequestContextKeyStruct{}
Functions ¶
func DialContextWithTimeout ¶
func GuessCurrentAppURL ¶
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 GuessCurrentHostURL ¶
GuessCurrentHostURL tries to guess the current full host URL (no sub-path) by http headers, there is no trailing slash.
func IsRelativeURL ¶
IsRelativeURL detects if a URL is relative (no scheme or host)
func MakeAbsoluteURL ¶
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 ServeContentByReadSeeker ¶
func ServeContentByReadSeeker(r *http.Request, w http.ResponseWriter, modTime *time.Time, reader io.ReadSeeker, opts *ServeHeaderOptions)
func ServeContentByReader ¶
func ServeContentByReader(r *http.Request, w http.ResponseWriter, size int64, reader io.Reader, opts *ServeHeaderOptions)
func ServeSetHeaders ¶
func ServeSetHeaders(w http.ResponseWriter, opts *ServeHeaderOptions)
ServeSetHeaders sets necessary content serve headers
Types ¶
type GiteaSiteURL ¶
func ParseGiteaSiteURL ¶
func ParseGiteaSiteURL(ctx context.Context, s string) *GiteaSiteURL
type Request ¶
type Request struct {
// contains filtered or unexported fields
}
func (*Request) Body ¶
Body adds request raw body. It supports string, []byte and io.Reader as body.
func (*Request) Header ¶
Header set header item string in request.
func (*Request) Param ¶
Param adds query param in to request. params build query string as ?key1=value1&key2=value2...
func (*Request) Response ¶
Response executes request client and returns the response. Caller MUST close the response body if no error occurs.
func (*Request) SetContext ¶
SetContext sets the request's Context
func (*Request) SetReadWriteTimeout ¶
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"
ContentTypeCharset string
ContentLength *int64
Disposition string // defaults to "attachment"
Filename string
CacheIsPublic bool
CacheDuration time.Duration // defaults to 5 minutes
LastModified time.Time
}
Source Files
¶
- request.go
- serve.go
- url.go