uritemplates

package

v0.7.1 Latest Latest Go to latest Published: Mar 23, 2026 License: BSD-3-Clause Imports: 13 Imported by: 4

Details

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

Repository

github.com/Carbonfrost/joe-cli-http

Links

Open Source Insights

Documentation ¶

Index ¶

func Expand() cli.Action
func FlagsAndArgs() cli.Action
func SetPartialExpand(b ...bool) cli.Action
func SetURITemplateVar(v ...*Var) cli.Action
func SetURITemplateVars(v ...*Vars) cli.Action
func SourceAnnotation() (string, string)
type URITemplate
- func Parse(text string) (*URITemplate, error)
type Var
type VarType
- func (t VarType) String() string
type Vars

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Expand ¶

func Expand() cli.Action

func FlagsAndArgs ¶

func FlagsAndArgs() cli.Action

func SetPartialExpand ¶

func SetPartialExpand(b ...bool) cli.Action

func SetURITemplateVar ¶

func SetURITemplateVar(v ...*Var) cli.Action

func SetURITemplateVars ¶

func SetURITemplateVars(v ...*Vars) cli.Action

func SourceAnnotation ¶

func SourceAnnotation() (string, string)

SourceAnnotation gets the name and value of the annotation added to the Data of all flags that are initialized from this package

Types ¶

type URITemplate ¶

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

URITemplate is a parsed representation of a URI template, which can also be used as a flag Value

func Parse ¶

func Parse(text string) (*URITemplate, error)

Parse obtains a URI template from a string

func (*URITemplate) Expand ¶

func (u *URITemplate) Expand(value any) (string, error)

Expand expands a URI template. The value is Vars, a map[string]any, or an arbitrary struct (or pointer to one). When a struct, reflection is used to obtain the values by name, and the tag `uri` can be used to override the name.

func (*URITemplate) MarshalText ¶

func (u *URITemplate) MarshalText() ([]byte, error)

MarshalText provides the textual representation

func (*URITemplate) Names ¶

func (u *URITemplate) Names() []string

Names retrieves the names of the template variables

func (*URITemplate) PartialExpand ¶

func (u *URITemplate) PartialExpand(value any) (*URITemplate, error)

PartialExpand expands a URI template, leaving any expansions which could not be filled

func (*URITemplate) Set ¶

func (u *URITemplate) Set(arg string) error

Set provides the behavior when the template is used as a flag on the command line

func (*URITemplate) String ¶

func (u *URITemplate) String() string

String converts the template to a string

func (*URITemplate) UnmarshalText ¶

func (u *URITemplate) UnmarshalText(b []byte) error

UnmarshalText converts the textual representation

type Var ¶

type Var struct {
	Name  string
	Value any
	// contains filtered or unexported fields
}

Var is a variable in a URI template

func ArrayVar ¶

func ArrayVar(name string, values ...any) *Var

func MapVar ¶

func MapVar(name string, values map[string]any) *Var

func NewVar ¶ added in v0.6.0

func NewVar(name string, value any) *Var

func StringVar ¶

func StringVar(name string, value string) *Var

func (*Var) Copy ¶

func (v *Var) Copy() *Var

func (*Var) NewCounter ¶

func (v *Var) NewCounter() cli.ArgCounter

func (*Var) Reset ¶

func (v *Var) Reset()

func (*Var) Set ¶

func (v *Var) Set(arg string) error

func (*Var) String ¶

func (v *Var) String() string

func (*Var) Synopsis ¶

func (*Var) Synopsis() string

func (*Var) Type ¶

func (v *Var) Type() VarType

type VarType ¶

type VarType int

VarType enumerates the types of variables in the expression of a URI template

const (
	String VarType = iota
	Array
	Map
)

Types of variables

func (VarType) String ¶

func (t VarType) String() string

type Vars ¶

type Vars map[string]any

Vars provides template variables

func (Vars) Add ¶

func (t Vars) Add(v ...*Var)

func (*Vars) Copy ¶

func (t *Vars) Copy() *Vars

func (Vars) Items ¶

func (t Vars) Items() []*Var

func (*Vars) Reset ¶

func (t *Vars) Reset()

func (*Vars) Set ¶

func (t *Vars) Set(arg string) error

func (Vars) String ¶

func (t Vars) String() string

func (Vars) Update ¶

func (t Vars) Update(u map[string]any) (err error)

Source Files ¶

View all Source files

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