types

Documentation

Index

• Variables
• type OperationMeta
  • func (m OperationMeta) UA() string
• type OperationMetaProvider
• type RequestMeta
• type ServerMeta
  • func (m ServerMeta) UA() string

Examples

• ServerMeta

Variables

var (
	OperationMetaFrom  = contextx.From[tCtxOperationMeta, *OperationMeta]
	WithOperationMeta  = contextx.With[tCtxOperationMeta, *OperationMeta]
	MustOperationMeta  = contextx.Must[tCtxOperationMeta, *OperationMeta]
	CarryOperationMeta = contextx.Carry[tCtxOperationMeta, *OperationMeta]

	RequestFrom  = contextx.From[tCtxRequest, *http.Request]
	WithRequest  = contextx.With[tCtxRequest, *http.Request]
	MustRequest  = contextx.Must[tCtxRequest, *http.Request]
	CarryRequest = contextx.Carry[tCtxRequest, *http.Request]

	OperationMetaProviderFrom  = contextx.From[tCtxOperationMetaProvider, OperationMetaProvider]
	WithOperationMetaProvider  = contextx.With[tCtxOperationMetaProvider, OperationMetaProvider]
	MustOperationMetaProvider  = contextx.Must[tCtxOperationMetaProvider, OperationMetaProvider]
	CarryOperationMetaProvider = contextx.Carry[tCtxOperationMetaProvider, OperationMetaProvider]
)

var (
	PkgRoot     string
	ExposedRoot string
)

Types

type OperationMeta

type OperationMeta struct {
	ServerMeta
	RequestMeta
}

func (OperationMeta) UA

func (m OperationMeta) UA() string

type OperationMetaProvider

type OperationMetaProvider interface {
	GetOperation(id string) (OperationMeta, bool)
}

type RequestMeta

type RequestMeta struct {
	ID     string
	Method string
	Route  string
}

type ServerMeta

type ServerMeta struct {
	Name    string
	Version string
}

Example

sm := ServerMeta{
	Name: "server-name",
	// Version: "v0.0.1",
}
fmt.Println(sm.UA())
sm.Version = "v0.0.1"
fmt.Println(sm.UA())

rm := RequestMeta{
	Method: "GET",
	Route:  "/path/to/route",
}
om := OperationMeta{
	ServerMeta:  sm,
	RequestMeta: rm,
}
fmt.Println(om.UA())
om.ID = "OperatorX"
fmt.Println(om.UA())

Output:
server-name
server-name@v0.0.1
server-name@v0.0.1(unknown)
server-name@v0.0.1(OperatorX)

func (ServerMeta) UA

func (m ServerMeta) UA() string