urlstruct

package

v1.7.3 Latest Latest Go to latest Published: Apr 23, 2024 License: AGPL-3.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/uptrace/uptrace

Links

Open Source Insights

Documentation ¶

Index ¶

func ParseDuration(s string) (time.Duration, error)
func Unmarshal(ctx context.Context, values url.Values, strct any) error
type Field
- func (f *Field) Value(strct reflect.Value) reflect.Value
type Pager
- func NewPager(values url.Values) *Pager
type ParamUnmarshaler
type StructInfo
- func DescribeStruct(typ reflect.Type) *StructInfo
- func (sinfo *StructInfo) Field(name string) *Field
type Values
type ValuesUnmarshaler

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ParseDuration ¶

func ParseDuration(s string) (time.Duration, error)

func Unmarshal ¶

func Unmarshal(ctx context.Context, values url.Values, strct any) error

Unmarshal unmarshals the URL query values into the struct.

Types ¶

type Field ¶

type Field struct {
	Type  reflect.Type
	Name  string
	Index []int
	Tag   *tagparser.Tag
	// contains filtered or unexported fields
}

func (*Field) Value ¶

func (f *Field) Value(strct reflect.Value) reflect.Value

type Pager struct {
	Limit  int
	Offset int

	// Default is 100.
	DefaultLimit int `urlstruct:"-"`
	// Default is 1000.
	MaxLimit int `urlstruct:"-"`

	// Default max offset is 1000000.
	MaxOffset int `urlstruct:"-"`
	// contains filtered or unexported fields
}

func NewPager ¶

func NewPager(values url.Values) *Pager

func (p *Pager) GetLimit() int

func (p *Pager) GetOffset() int

func (p *Pager) GetPage() int

func (p *Pager) SetPage(page int)

func (p *Pager) UnmarshalValues(ctx context.Context, values url.Values) error

type ParamUnmarshaler ¶

type ParamUnmarshaler interface {
	UnmarshalParam(ctx context.Context, name string, values []string) error
}

type StructInfo ¶

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

func DescribeStruct ¶

func DescribeStruct(typ reflect.Type) *StructInfo

func (*StructInfo) Field ¶

func (sinfo *StructInfo) Field(name string) *Field

type Values ¶

type Values url.Values

func (Values) Bool ¶

func (v Values) Bool(name string) (bool, error)

func (Values) Duration ¶

func (v Values) Duration(name string) (time.Duration, error)

func (Values) Float64 ¶

func (v Values) Float64(name string) (float64, error)

func (Values) Has ¶

func (v Values) Has(name string) bool

func (Values) Int ¶

func (v Values) Int(name string) (int, error)

func (Values) Int64 ¶

func (v Values) Int64(name string) (int64, error)

func (Values) MaybeBool ¶

func (v Values) MaybeBool(name string) bool

func (Values) MaybeDuration ¶

func (v Values) MaybeDuration(name string) time.Duration

func (Values) MaybeFloat64 ¶

func (v Values) MaybeFloat64(name string) float64

func (Values) MaybeInt ¶

func (v Values) MaybeInt(name string) int

func (Values) MaybeInt64 ¶

func (v Values) MaybeInt64(name string) int64

func (Values) MaybeTime ¶

func (v Values) MaybeTime(name string) time.Time

func (v Values) Pager() *Pager

func (Values) SetDefault ¶

func (v Values) SetDefault(name string, values ...string)

func (Values) String ¶

func (v Values) String(name string) string

func (Values) Strings ¶

func (v Values) Strings(name string) []string

func (Values) Time ¶

func (v Values) Time(name string) (time.Time, error)

type ValuesUnmarshaler ¶

type ValuesUnmarshaler interface {
	UnmarshalValues(ctx context.Context, values url.Values) error
}

Source Files ¶

View all Source files

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