namespace

Documentation

Index

• Constants
• Variables
• func Canonicalize(nsPath string) string
• func ContextWithNamespace(ctx context.Context, ns *Namespace) context.Context
• func RootContext(ctx context.Context) context.Context
• func TestContext() context.Context
• type Namespace
  • func FromContext(ctx context.Context) (*Namespace, error)
  • func TestNamespace() *Namespace
  • func (n *Namespace) HasParent(possibleParent *Namespace) bool
  • func (n *Namespace) TrimmedPath(path string) string

Constants

const (
	RootNamespaceID = "root"
)

Variables

var (
	ErrNoNamespace error      = errors.New("no namespace")
	RootNamespace  *Namespace = &Namespace{
		ID:   RootNamespaceID,
		Path: "",
	}
)

var AdjustRequest = func(r *http.Request) (*http.Request, int) {
	return r.WithContext(ContextWithNamespace(r.Context(), RootNamespace)), 0
}

Functions

func Canonicalize

func Canonicalize(nsPath string) string

Canonicalize trims any prefix '/' and adds a trailing '/' to the provided string

func ContextWithNamespace

func ContextWithNamespace(ctx context.Context, ns *Namespace) context.Context

func RootContext

func RootContext(ctx context.Context) context.Context

func TestContext

func TestContext() context.Context

Types

type Namespace

type Namespace struct {
	ID   string `json:"id"`
	Path string `json:"path"`
}

func FromContext

func FromContext(ctx context.Context) (*Namespace, error)

This function caches the ns to avoid doing a .Value lookup over and over, because it's called a *lot* in the request critical path. .Value is concurrency-safe so uses some kind of locking/atomicity, but it should never be read before first write, plus we don't believe this will be called from different goroutines, so it should be safe.

func TestNamespace

func TestNamespace() *Namespace

func (*Namespace) HasParent

func (n *Namespace) HasParent(possibleParent *Namespace) bool

func (*Namespace) TrimmedPath

func (n *Namespace) TrimmedPath(path string) string