README
¶
Package cloudeng.io/webapp/goget
import cloudeng.io/webapp/goget
Types
Type Option
type Option func(*options)
Option is used to configure the creation and registration of go-get handlers.
Functions
func WithCounter(counter webapp.CounterInc) Option
WithCounter configures the handler to increment the provided metric when a go-get request is handled.
Type Spec
type Spec struct {
ImportPath string `yaml:"import" cmd:"import path" json:"import"`
Content string `yaml:"content" cmd:"content of the go-get meta tag" json:"content"`
// contains filtered or unexported fields
}
Spec represents a go-get meta tag specification. From https://go.dev/ref/mod#serving-from-proxy "The tag’s content must contain the repository root path, the version control system, and the URL, separated by spaces. See Finding a repository for a module path for details.
Methods
func (s *Spec) Hostname() string
Hostname returns the hostname component of the import path. Use SplitHostnamePath to perform the split if Spec was not unmarshalled from YAML.
func (s *Spec) NewHandler(next http.Handler, opts ...Option) (http.Handler, error)
NewHandler creates a new http.Handler for a given go-get specification and returns the path that the handler should be registered at, without the trailing slash. The returned handler will call the provided next handler if the request is not a go-get request. Take care to set the appropriate next handler for the root path "/". The go-get redirect will be served if go-get=1 is present in the query parameters and the request path matches the path component of the import path. If the request includes a host name, it must match the hostname component of the import path.
func (s *Spec) Path() string
Path returns the path component of the import path. Use SplitHostnamePath to perform the split if Spec was not unmarshalled from YAML.
func (s *Spec) SplitHostnamePath() error
SplitHostnamePath splits the import path into the hostname and path components. The path component will have any trailing slash removed. Use the Hostname and Path methods to retrieve the components.
func (s Spec) String() string
func (s *Spec) UnmarshalYAML(value *yaml.Node) error
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*options)
Option is used to configure the creation and registration of go-get handlers.
func WithCounter ¶
func WithCounter(counter webapp.CounterInc) Option
WithCounter configures the handler to increment the provided metric when a go-get request is handled.
type Spec ¶
type Spec struct {
ImportPath string `yaml:"import" cmd:"import path" json:"import"`
Content string `yaml:"content" cmd:"content of the go-get meta tag" json:"content"`
// contains filtered or unexported fields
}
Spec represents a go-get meta tag specification. From https://go.dev/ref/mod#serving-from-proxy "The tag’s content must contain the repository root path, the version control system, and the URL, separated by spaces. See Finding a repository for a module path for details.
func (*Spec) Hostname ¶
Hostname returns the hostname component of the import path. Use SplitHostnamePath to perform the split if Spec was not unmarshalled from YAML.
func (*Spec) NewHandler ¶
NewHandler creates a new http.Handler for a given go-get specification and returns the path that the handler should be registered at, without the trailing slash. The returned handler will call the provided next handler if the request is not a go-get request. Take care to set the appropriate next handler for the root path "/". The go-get redirect will be served if go-get=1 is present in the query parameters and the request path matches the path component of the import path. If the request includes a host name, it must match the hostname component of the import path.
func (*Spec) Path ¶
Path returns the path component of the import path. Use SplitHostnamePath to perform the split if Spec was not unmarshalled from YAML.
func (*Spec) SplitHostnamePath ¶
SplitHostnamePath splits the import path into the hostname and path components. The path component will have any trailing slash removed. Use the Hostname and Path methods to retrieve the components.
Source Files