namespace

package

v1.1.0 Latest Latest Go to latest Published: Mar 18, 2019 License: MPL-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/conversable/vault

Links

Open Source Insights

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 SplitIDFromString(input string) (string, string)
type Namespace
- func FromContext(ctx context.Context) (*Namespace, error)
- func (n *Namespace) HasParent(possibleParent *Namespace) bool
- func (n *Namespace) TrimmedPath(path string) string

Constants ¶

View Source

const (
	RootNamespaceID = "root"
)

Variables ¶

View Source

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

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 SplitIDFromString ¶ added in v0.11.2

func SplitIDFromString(input string) (string, string)

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 (*Namespace) HasParent ¶

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

func (*Namespace) TrimmedPath ¶

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

Source Files ¶

View all Source files

namespace.go

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