uri

Documentation

Overview

Package uri handles the Telehash URI format.

Reference

See: https://github.com/telehash/telehash.org/blob/master/v3/uri.md

Index

• func Resolve(uri *URI) (*e3x.Identity, error)
• func WellKnown(e *e3x.Endpoint) http.Handler
• type InvalidURIError
  • func (e InvalidURIError) Error() string
• type URI
  • func Parse(rawstr string) (*URI, error)
  • func (uri *URI) String() string

Functions

func Resolve

func Resolve(uri *URI) (*e3x.Identity, error)

Resolve resolves a URI into an Identity.

func WellKnown

func WellKnown(e *e3x.Endpoint) http.Handler

WellKnown returns an http.Handler which will serve the /.well-known/mesh.json document for Endpoint.

Types

type InvalidURIError

type InvalidURIError string

InvalidURIError is returned when Parse has invalid input

func (InvalidURIError) Error

func (e InvalidURIError) Error() string

type URI

type URI struct {
	Protocol  string
	User      string
	Canonical string
	Session   string
	Token     string
}

URI represents a Telehash URI. It can be resolved to an Identity.

func Parse

func Parse(rawstr string) (*URI, error)

Parse parses a Telehash URI.

func (*URI) String

func (uri *URI) String() string