response

package
v0.29.6 Latest Latest
Warning

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

Go to latest
Published: May 22, 2023 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// HeaderContentType name of Content-Type header
	HeaderContentType = "content-type"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Response

type Response struct {
	StatusCode    int         // status code of response
	Headers       http.Header // headers for response
	ContentLength int64       // if buffered response contains length of buffer, for streams it equal to -1
	// contains filtered or unexported fields
}

Response is helper struct for wrapping different storage response

func New

func New(statusCode int, body io.ReadCloser) *Response

New create response object with io.ReadCloser

func NewBuf

func NewBuf(statusCode int, body []byte) *Response

NewBuf create response object from []byte

func NewError

func NewError(statusCode int, err error) *Response

NewError create response object from error

func NewNoContent

func NewNoContent(statusCode int) *Response

NewNoContent create response object without content

func NewString

func NewString(statusCode int, body string) *Response

NewString create response object from string

func (*Response) Body added in v0.15.0

func (r *Response) Body() ([]byte, error)

Body reads all content of response and returns []byte Content of the response is changed Such response shouldn't be Send to client

func (*Response) BodyTransformer added in v0.11.0

func (r *Response) BodyTransformer(w bodyTransformFnc)

BodyTransformer add function that will transform body before send to client

func (*Response) Close

func (r *Response) Close()

Close response reader

func (*Response) Copy

func (r *Response) Copy() (*Response, error)

Copy create complete response copy with headers and body

func (*Response) CopyBody

func (r *Response) CopyBody() ([]byte, error)

CopyBody returns a copy of Body in []byte

func (*Response) DecodeMsgpack added in v0.13.0

func (r *Response) DecodeMsgpack(dec *msgpack.Decoder) error

func (*Response) EncodeMsgpack added in v0.13.0

func (r *Response) EncodeMsgpack(enc *msgpack.Encoder) error

func (*Response) Error

func (r *Response) Error() error

Error returns error instance

func (*Response) GetTTL added in v0.13.0

func (r *Response) GetTTL() int

func (*Response) HasError

func (r *Response) HasError() bool

HasError check if response contains error

func (*Response) IsBuffered

func (r *Response) IsBuffered() bool

IsBuffered check if response has access to original buffer

func (*Response) IsCacheable added in v0.13.0

func (r *Response) IsCacheable() bool

func (*Response) IsFromCache added in v0.24.0

func (r *Response) IsFromCache() bool

func (*Response) IsImage added in v0.11.0

func (r *Response) IsImage() bool

IsImage check if response is image

func (*Response) Send

func (r *Response) Send(w http.ResponseWriter) error

Send write response to client using streaming

func (*Response) SendContent added in v0.3.0

func (r *Response) SendContent(req *http.Request, w http.ResponseWriter) error

SendContent use http.ServeContent to return response to client It can handle range and condition requests In this function we don't need to use transformer because it don't serve whole body It is used for range and condition requests

func (*Response) Set

func (r *Response) Set(headerName string, headerValue string)

Set update response headers

func (*Response) SetCacheHit added in v0.24.0

func (r *Response) SetCacheHit()

func (*Response) SetContentType

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

SetContentType update content type header of response

func (*Response) SetDebug

func (r *Response) SetDebug(obj *object.FileObject) *Response

SetDebug set flag indicating that response can including debug information

func (*Response) SetTransforms added in v0.15.0

func (r *Response) SetTransforms(trans []transforms.Transforms)

func (*Response) Stream

func (r *Response) Stream() io.ReadCloser

Stream return io.Reader interface from correct response content

Jump to

Keyboard shortcuts

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