http_requests

package

v0.0.0-...-e06565c Latest Latest Go to latest Published: Jun 22, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ArcherChu123/plugin-daemon

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func DeleteAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)
func GetAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)
func GetAndParseStream[T any](client *http.Client, url string, options ...HttpOptions) (*stream.Stream[T], error)
func PatchAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)
func PostAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)
func PostAndParseStream[T any](client *http.Client, url string, options ...HttpOptions) (*stream.Stream[T], error)
func PutAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)
func PutAndParseStream[T any](client *http.Client, url string, options ...HttpOptions) (*stream.Stream[T], error)
func Request(client *http.Client, url string, method string, options ...HttpOptions) (*http.Response, error)
func RequestAndParse[T any](client *http.Client, url string, method string, options ...HttpOptions) (*T, error)
func RequestAndParseStream[T any](client *http.Client, url string, method string, options ...HttpOptions) (*stream.Stream[T], error)
type HttpOptions
type HttpPayloadMultipartFile

Constants ¶

View Source

const (
	HttpOptionTypeWriteTimeout                     = "write_timeout"
	HttpOptionTypeReadTimeout                      = "read_timeout"
	HttpOptionTypeHeader                           = "header"
	HttpOptionTypeParams                           = "params"
	HttpOptionTypePayload                          = "payload"
	HttpOptionTypePayloadText                      = "payloadText"
	HttpOptionTypePayloadJson                      = "payloadJson"
	HttpOptionTypePayloadMultipart                 = "payloadMultipart"
	HttpOptionTypeRaiseErrorWhenStreamDataNotMatch = "raiseErrorWhenStreamDataNotMatch"
	HttpOptionTypeDirectReferer                    = "directReferer"
	HttpOptionTypeRetCode                          = "retCode"
	HttpOptionTypeUsingLengthPrefixed              = "usingLengthPrefixed"
)

Variables ¶

This section is empty.

Functions ¶

func DeleteAndParse ¶

func DeleteAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)

func GetAndParse ¶

func GetAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)

func GetAndParseStream ¶

func GetAndParseStream[T any](client *http.Client, url string, options ...HttpOptions) (*stream.Stream[T], error)

func PatchAndParse ¶

func PatchAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)

func PostAndParse ¶

func PostAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)

func PostAndParseStream ¶

func PostAndParseStream[T any](client *http.Client, url string, options ...HttpOptions) (*stream.Stream[T], error)

func PutAndParse ¶

func PutAndParse[T any](client *http.Client, url string, options ...HttpOptions) (*T, error)

func PutAndParseStream ¶

func PutAndParseStream[T any](client *http.Client, url string, options ...HttpOptions) (*stream.Stream[T], error)

func Request ¶

func Request(client *http.Client, url string, method string, options ...HttpOptions) (*http.Response, error)

func RequestAndParse ¶

func RequestAndParse[T any](client *http.Client, url string, method string, options ...HttpOptions) (*T, error)

func RequestAndParseStream ¶

func RequestAndParseStream[T any](client *http.Client, url string, method string, options ...HttpOptions) (*stream.Stream[T], error)

Types ¶

type HttpOptions ¶

type HttpOptions struct {
	Type  string
	Value interface{}
}

func HttpHeader ¶

func HttpHeader(header map[string]string) HttpOptions

func HttpPayloadMultipart ¶

func HttpPayloadMultipart(payload map[string]string, files map[string]HttpPayloadMultipartFile) HttpOptions

which is used for POST method only payload follows the form data format, and files is a map from filename to file

func HttpRaiseErrorWhenStreamDataNotMatch ¶

func HttpRaiseErrorWhenStreamDataNotMatch(raise bool) HttpOptions

func HttpUsingLengthPrefixed ¶

func HttpUsingLengthPrefixed(using bool) HttpOptions

For standard SSE protocol, response are split by \n\n Which leads a bad performance when decoding, we need a larger chunk to store temporary data This option is used to enable length-prefixed mode, which is faster but less memory-friendly We uses following format:

| Field         | Size     | Description                     |
|---------------|----------|---------------------------------|
| Magic Number  | 1 byte   | Magic number identifier         |
| Reserved      | 1 byte   | Reserved field                  |
| Header Length | 2 bytes  | Header length (usually 0xa)    |
| Data Length   | 4 bytes  | Length of the data              |
| Reserved      | 6 bytes  | Reserved fields                 |
| Data          | Variable | Actual data content             |

| Reserved Fields | Header   | Data     |
|-----------------|----------|----------|
| 4 bytes total   | Variable | Variable |

with the above format, we can achieve a better performance, avoid unexpected memory growth

func HttpWithDirectReferer ¶

func HttpWithDirectReferer() HttpOptions

func HttpWithRetCode ¶

func HttpWithRetCode(retCode *int) HttpOptions

func HttpWriteTimeout ¶

func HttpWriteTimeout(timeout int64) HttpOptions

milliseconds

type HttpPayloadMultipartFile ¶

type HttpPayloadMultipartFile struct {
	Filename string
	Reader   io.Reader
}

Source Files ¶

View all Source files

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