mrreq

Documentation

Index

• Constants
• Variables
• func FormFile(r *http.Request, key string) (*multipart.FileHeader, error)
• func FormFiles(r *http.Request, key string, maxMemory int64) ([]*multipart.FileHeader, error)
• func ParseCorrelationID(getter valueGetter) (string, error)
• func ParseDateTime(getter valueGetter, key string, required bool) (time.Time, error)
• func ParseEnum(getter valueGetter, key string, required bool) (string, error)
• func ParseEnumList(getter valueGetter, key string) ([]string, error)
• func ParseFloat64(getter valueGetter, key string, required bool) (float64, error)
• func ParseInt64(getter valueGetter, key string, required bool) (int64, error)
• func ParseInt64List(getter valueGetter, key string) ([]int64, error)
• func ParseLanguage(getter valueGetter) []string
• func ParseNullableBool(getter valueGetter, key string) (*bool, error)
• func ParsePageParams(getter valueGetter, keyIndex, keySize string) (mrtype.PageParams, error)
• func ParseRangeFloat64(getter valueGetter, prefixKey string) (mrtype.RangeFloat64, error)
• func ParseRangeInt64(getter valueGetter, prefixKey string) (mrtype.RangeInt64, error)
• func ParseRequiredBool(getter valueGetter, key string) (bool, error)
• func ParseSortParams(getter valueGetter, keyField, keyDirection string) (mrtype.SortParams, error)
• func ParseStr(getter valueGetter, key string, required bool) (string, error)
• func ParseStrList(getter valueGetter, key string) ([]string, error)
• func ParseUUID(getter valueGetter, key string, required bool) (uuid.UUID, error)
• func ParseUint64(getter valueGetter, key string, required bool) (uint64, error)
• func ParseUint64List(getter valueGetter, key string) ([]uint64, error)
• func ParseUserIP(remoteAddr string) (net.IP, error)

Constants

const (
	// HeaderKeyAcceptLanguage - название заголовка содержащий предпочитаемые клиентом языки общения.
	HeaderKeyAcceptLanguage = "Accept-Language"

	// HeaderKeyCorrelationID - название заголовка содержащий внешний клиентский ID под которым делается запрос.
	// sample: f7479171-83d2-4f64-84ac-892f8c0aaf48 | csoruadf3kkopl6lok80.
	HeaderKeyCorrelationID = "X-Correlation-Id"

	// HeaderKeyIdempotencyKey - название заголовка содержащего ключ идемпотентности операции.
	// sample: 12b779ee-6bfd-495a-94ba-e4fa517f0268
	HeaderKeyIdempotencyKey = "X-Idempotency-Key"

	// HeaderKeyRequestID - название заголовка содержащего ID текущего запроса.
	// sample: 3c0b88e8-ba21-4d49-afda-d92e7ac08918, cs0n2utf3kkujsmnq9og.
	HeaderKeyRequestID = "X-Request-Id"
)

Variables

var (
	// ErrHttpRequestCorrelationID - header 'X-Correlation-Id' contains incorrect value.
	ErrHttpRequestCorrelationID = mrerr.NewProto(
		"errHttpRequestCorrelationID", mrerr.ErrorKindInternal, "header 'X-Correlation-Id' contains incorrect value '{{ .value }}'")

	// ErrHttpRequestUserIP - userIP is not IP:port.
	ErrHttpRequestUserIP = mrerr.NewProto(
		"errHttpRequestUserIP", mrerr.ErrorKindInternal, "userIP '{{ .value }}' is not IP:port")

	// ErrHttpRequestParseUserIP - userIP contains incorrect value.
	ErrHttpRequestParseUserIP = mrerr.NewProto(
		"errHttpRequestParseUserIP", mrerr.ErrorKindInternal, "userIP contains incorrect value '{{ .value }}'")
)

Functions

func FormFile

func FormFile(r *http.Request, key string) (*multipart.FileHeader, error)

FormFile - возвращает файл из внешнего источника (multipart/form-data) по указанному ключу.

func FormFiles

func FormFiles(r *http.Request, key string, maxMemory int64) ([]*multipart.FileHeader, error)

FormFiles - возвращает список файлов из внешнего источника (multipart/form-data) по указанному ключу.

func ParseCorrelationID

func ParseCorrelationID(getter valueGetter) (string, error)

ParseCorrelationID - возвращает значение заголовка CorrelationID. Если заголовка нет или он пустой, то вернётся пустое значение.

func ParseDateTime

func ParseDateTime(getter valueGetter, key string, required bool) (time.Time, error)

ParseDateTime - возвращает time.Time значение из внешнего строкового параметра по указанному ключу. Значение строкового параметра должно быть указано в формате RFC3339. Если параметр пустой, то в зависимости от required возвращается нулевое время или ошибка.

func ParseEnum

func ParseEnum(getter valueGetter, key string, required bool) (string, error)

ParseEnum - возвращает Enum значение из внешнего строкового параметра по указанному ключу. Если параметр пустой, то в зависимости от required возвращается пустая строка или ошибка.

func ParseEnumList

func ParseEnumList(getter valueGetter, key string) ([]string, error)

ParseEnumList - возвращает массив Enum значений из внешнего строкового параметра по указанному ключу. Если параметр пустой, то возвращается пустой массив.

func ParseFloat64

func ParseFloat64(getter valueGetter, key string, required bool) (float64, error)

ParseFloat64 - возвращает Float64 значение из внешнего строкового параметра по указанному ключу. Если параметр пустой, то в зависимости от required возвращается 0 или ошибка.

func ParseInt64

func ParseInt64(getter valueGetter, key string, required bool) (int64, error)

ParseInt64 - возвращает Int64 значение из внешнего строкового параметра по указанному ключу. Если параметр пустой, то в зависимости от required возвращается 0 или ошибка.

func ParseInt64List

func ParseInt64List(getter valueGetter, key string) ([]int64, error)

ParseInt64List - возвращает массив Int64 значений из внешнего строкового параметра по указанному ключу. Если параметр пустой, то возвращается пустой массив.

func ParseLanguage

func ParseLanguage(getter valueGetter) []string

ParseLanguage - возвращает список языков из заголовка Accept-Language. Если заголовка нет или он пустой, то возвращается пустой массив.

func ParseNullableBool

func ParseNullableBool(getter valueGetter, key string) (*bool, error)

ParseNullableBool - возвращает Bool значение из внешнего строкового параметра по указанному ключу. Если параметр пустой, то возвращается nil.

func ParsePageParams

func ParsePageParams(getter valueGetter, keyIndex, keySize string) (mrtype.PageParams, error)

ParsePageParams - возвращает PageParams из строковых параметров по указанным ключам.

func ParseRangeFloat64

func ParseRangeFloat64(getter valueGetter, prefixKey string) (mrtype.RangeFloat64, error)

ParseRangeFloat64 - возвращает RangeFloat64 из строковых параметров по указанному префиксу ключа.

func ParseRangeInt64

func ParseRangeInt64(getter valueGetter, prefixKey string) (mrtype.RangeInt64, error)

ParseRangeInt64 - возвращает RangeInt64 из строковых параметров по указанному префиксу ключа.

func ParseRequiredBool

func ParseRequiredBool(getter valueGetter, key string) (bool, error)

ParseRequiredBool - возвращает Bool значение из внешнего строкового параметра по указанному ключу. Если параметр пустой, то возвращается ошибка.

func ParseSortParams

func ParseSortParams(getter valueGetter, keyField, keyDirection string) (mrtype.SortParams, error)

ParseSortParams - возвращает SortParams из строковых параметров по указанным ключам.

func ParseStr

func ParseStr(getter valueGetter, key string, required bool) (string, error)

ParseStr - возвращает строковое значение из внешнего строкового параметра по указанному ключу. Если параметр пустой, то в зависимости от required возвращается пустая строка или ошибка.

func ParseStrList

func ParseStrList(getter valueGetter, key string) ([]string, error)

ParseStrList - возвращает массив строковых значений из внешнего строкового параметра по указанному ключу. Если параметр пустой, то возвращается пустой массив.

func ParseUUID

func ParseUUID(getter valueGetter, key string, required bool) (uuid.UUID, error)

ParseUUID - возвращает UUID значение из внешнего строкового параметра по указанному ключу. Если параметр пустой, то в зависимости от required возвращается нулевой UUID или ошибка.

func ParseUint64

func ParseUint64(getter valueGetter, key string, required bool) (uint64, error)

ParseUint64 - возвращает Uint64 значение из внешнего строкового параметра по указанному ключу. Если параметр пустой, то в зависимости от required возвращается 0 или ошибка.

func ParseUint64List

func ParseUint64List(getter valueGetter, key string) ([]uint64, error)

ParseUint64List - возвращает массив Uint64 значений из внешнего строкового параметра по указанному ключу. Если параметр пустой, то возвращается пустой массив.

func ParseUserIP

func ParseUserIP(remoteAddr string) (net.IP, error)

ParseUserIP - возвращает валидный IP адрес из указанной строки или ошибку, если парсинг не удался.