xrd

package

v0.0.0-...-30adf6a Latest Latest Go to latest Published: Nov 20, 2018 License: MIT Imports: 6 Imported by: 3

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/emersion/go-ostatus

Links

Open Source Insights

Documentation ¶

Overview ¶

Package xrd implements Extensible Resource Descriptor as defined in http://docs.oasis-open.org/xri/xrd/v1.0/xrd-1.0.html.

Index ¶

Variables
func NewHandler(be Backend) http.Handler
type Backend
type HTTPError
- func (err HTTPError) Error() string
type Link
type Resource
- func Get(url string) (*Resource, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNoSuchResource = errors.New("xrd: no such resource")

ErrNoSuchResource can be returned by a Backend if a resource doesn't exist.

Functions ¶

func NewHandler ¶

func NewHandler(be Backend) http.Handler

NewHandler creates a new XRD endpoint.

Types ¶

type Backend ¶

type Backend interface {
	Resource(req *http.Request) (*Resource, error)
}

A Backend is used to build an XRD endpoint.

type HTTPError ¶

type HTTPError int

An HTTPError is returned when an HTTP error has occured. Its value is the HTTP status code.

func (HTTPError) Error ¶

func (err HTTPError) Error() string

Error implements error.

type Link ¶

type Link struct {
	Rel        string            `xml:"rel,attr,omitempty" json:"rel"`
	Type       string            `xml:"type,attr,omitempty" json:"type,omitempty"`
	Href       string            `xml:"href,attr,omitempty" json:"href,omitempty"`
	Template   string            `xml:"template,attr,omitempty" json:"template,omitempty"`
	Titles     map[string]string `xml:"-" json:"titles,omitempty"`
	Properties map[string]string `xml:"-" json:"properties,omitempty"`
}

A Link provides a relationship between a resource and a URL.

type Resource ¶

type Resource struct {
	XMLName    xml.Name          `xml:"http://docs.oasis-open.org/ns/xri/xrd-1.0 XRD" json:"-"`
	Subject    string            `xml:"Subject" json:"subject,omitempty"`
	Aliases    []string          `xml:"Alias" json:"aliases,omitempty"`
	Properties map[string]string `xml:"-" json:"properties,omitempty"`
	Links      []*Link           `xml:"Link" json:"links,omitempty"`
}

A Resource is a resource descriptor.

func Get ¶

func Get(url string) (*Resource, error)

Get queries a resource.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
hostmeta Package hostmeta implements Web Host Metadata, as defined in https://tools.ietf.org/html/rfc6415.	Package hostmeta implements Web Host Metadata, as defined in https://tools.ietf.org/html/rfc6415.
lrdd Package lrdd implements Link-based Resource Descriptor Discovery as defined in https://tools.ietf.org/html/draft-hammer-discovery-04.	Package lrdd implements Link-based Resource Descriptor Discovery as defined in https://tools.ietf.org/html/draft-hammer-discovery-04.
webfinger Package webfinger implements WebFinger, as defined in https://tools.ietf.org/html/rfc7033.	Package webfinger implements WebFinger, as defined in https://tools.ietf.org/html/rfc7033.

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