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 SplitIDFromString(input string) (string, string)
• type MountPathDetails
  • func (mpd *MountPathDetails) GetFullPath() string
  • func (mpd *MountPathDetails) GetRelativePath(currNs *Namespace) string
• type Namespace
  • func FromContext(ctx context.Context) (*Namespace, error)
  • func (n *Namespace) HasParent(possibleParent *Namespace) bool
  • func (n *Namespace) String() string
  • 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:           "",
		CustomMetadata: make(map[string]string),
	}
)

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

func SplitIDFromString(input string) (string, string)

Types

type MountPathDetails

type MountPathDetails struct {
	Namespace *Namespace
	MountPath string
}

MountPathDetails contains the details of a mount's location, consisting of the namespace of the mount and the path of the mount within the namespace

func (*MountPathDetails) GetFullPath

func (mpd *MountPathDetails) GetFullPath() string

func (*MountPathDetails) GetRelativePath

func (mpd *MountPathDetails) GetRelativePath(currNs *Namespace) string

type Namespace

type Namespace struct {
	ID             string            `json:"id" mapstructure:"id"`
	Path           string            `json:"path" mapstructure:"path"`
	CustomMetadata map[string]string `json:"custom_metadata" mapstructure:"custom_metadata"`
}

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) String

func (n *Namespace) String() string

func (*Namespace) TrimmedPath

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