ref

Documentation

Overview

Package ref parses and formats the resource references services use to point at each other:

urn:<service>:<type>:<resource-id>

A reference is opaque to every service except the one named in its service segment.

Index

• Variables
• func Validate(s string) error
• type Ref
  • func MustNew(service, resourceType, id string) Ref
  • func New(service, resourceType, id string) (Ref, error)
  • func Parse(s string) (Ref, error)
  • func (r Ref) String() string
  • func (r Ref) Validate() error

Variables

var ErrInvalid = errors.New("invalid resource reference")

Functions

func Validate

func Validate(s string) error

Validate reports whether a raw string is a well-formed reference.

Types

type Ref

type Ref struct {
	Service      string
	ResourceType string
	ID           string
}

func MustNew

func MustNew(service, resourceType, id string) Ref

MustNew is for references built from values the caller already controls, such as a fresh UUID and a constant service name. It panics on anything else.

func New

func New(service, resourceType, id string) (Ref, error)

func Parse

func Parse(s string) (Ref, error)

func (Ref) String

func (r Ref) String() string

func (Ref) Validate

func (r Ref) Validate() error