reserved.vdl.go

// Copyright 2015 The Vanadium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// This file was auto-generated by the vanadium vdl tool.
// Package: reserved

//nolint:golint
package reserved

import (
	"fmt"

	"v.io/v23/context"
	"v.io/v23/i18n"
	"v.io/v23/verror"
)

var _ = initializeVDL() // Must be first; see initializeVDL comments for details.

// Error definitions
// =================

var (

	// ErrGlobMaxRecursionReached indicates that the Glob request exceeded the
	// max recursion level.
	ErrGlobMaxRecursionReached = verror.NewIDAction("v.io/v23/rpc/reserved.GlobMaxRecursionReached", verror.NoRetry)
	// ErrGlobMatchesOmitted indicates that some of the Glob results might
	// have been omitted due to access restrictions.
	ErrGlobMatchesOmitted = verror.NewIDAction("v.io/v23/rpc/reserved.GlobMatchesOmitted", verror.NoRetry)
	// ErrGlobNotImplemented indicates that Glob is not implemented by the
	// object.
	ErrGlobNotImplemented = verror.NewIDAction("v.io/v23/rpc/reserved.GlobNotImplemented", verror.NoRetry)
)

// NewErrGlobMaxRecursionReached returns an error with the ErrGlobMaxRecursionReached ID.
// Deprecated: this function will be removed in the future,
// use ErrorfGlobMaxRecursionReached or MessageGlobMaxRecursionReached instead.
func NewErrGlobMaxRecursionReached(ctx *context.T) error {
	return verror.New(ErrGlobMaxRecursionReached, ctx)
}

// ErrorfGlobMaxRecursionReached calls ErrGlobMaxRecursionReached.Errorf with the supplied arguments.
func ErrorfGlobMaxRecursionReached(ctx *context.T, format string) error {
	return ErrGlobMaxRecursionReached.Errorf(ctx, format)
}

// MessageGlobMaxRecursionReached calls ErrGlobMaxRecursionReached.Message with the supplied arguments.
func MessageGlobMaxRecursionReached(ctx *context.T, message string) error {
	return ErrGlobMaxRecursionReached.Message(ctx, message)
}

// ParamsErrGlobMaxRecursionReached extracts the expected parameters from the error's ParameterList.
func ParamsErrGlobMaxRecursionReached(argumentError error) (verrorComponent string, verrorOperation string, returnErr error) {
	params := verror.Params(argumentError)
	if params == nil {
		returnErr = fmt.Errorf("no parameters found in: %T: %v", argumentError, argumentError)
		return
	}
	iter := &paramListIterator{params: params, max: len(params)}

	if verrorComponent, verrorOperation, returnErr = iter.preamble(); returnErr != nil {
		return
	}

	return
}

// NewErrGlobMatchesOmitted returns an error with the ErrGlobMatchesOmitted ID.
// Deprecated: this function will be removed in the future,
// use ErrorfGlobMatchesOmitted or MessageGlobMatchesOmitted instead.
func NewErrGlobMatchesOmitted(ctx *context.T) error {
	return verror.New(ErrGlobMatchesOmitted, ctx)
}

// ErrorfGlobMatchesOmitted calls ErrGlobMatchesOmitted.Errorf with the supplied arguments.
func ErrorfGlobMatchesOmitted(ctx *context.T, format string) error {
	return ErrGlobMatchesOmitted.Errorf(ctx, format)
}

// MessageGlobMatchesOmitted calls ErrGlobMatchesOmitted.Message with the supplied arguments.
func MessageGlobMatchesOmitted(ctx *context.T, message string) error {
	return ErrGlobMatchesOmitted.Message(ctx, message)
}

// ParamsErrGlobMatchesOmitted extracts the expected parameters from the error's ParameterList.
func ParamsErrGlobMatchesOmitted(argumentError error) (verrorComponent string, verrorOperation string, returnErr error) {
	params := verror.Params(argumentError)
	if params == nil {
		returnErr = fmt.Errorf("no parameters found in: %T: %v", argumentError, argumentError)
		return
	}
	iter := &paramListIterator{params: params, max: len(params)}

	if verrorComponent, verrorOperation, returnErr = iter.preamble(); returnErr != nil {
		return
	}

	return
}

// NewErrGlobNotImplemented returns an error with the ErrGlobNotImplemented ID.
// Deprecated: this function will be removed in the future,
// use ErrorfGlobNotImplemented or MessageGlobNotImplemented instead.
func NewErrGlobNotImplemented(ctx *context.T) error {
	return verror.New(ErrGlobNotImplemented, ctx)
}

// ErrorfGlobNotImplemented calls ErrGlobNotImplemented.Errorf with the supplied arguments.
func ErrorfGlobNotImplemented(ctx *context.T, format string) error {
	return ErrGlobNotImplemented.Errorf(ctx, format)
}

// MessageGlobNotImplemented calls ErrGlobNotImplemented.Message with the supplied arguments.
func MessageGlobNotImplemented(ctx *context.T, message string) error {
	return ErrGlobNotImplemented.Message(ctx, message)
}

// ParamsErrGlobNotImplemented extracts the expected parameters from the error's ParameterList.
func ParamsErrGlobNotImplemented(argumentError error) (verrorComponent string, verrorOperation string, returnErr error) {
	params := verror.Params(argumentError)
	if params == nil {
		returnErr = fmt.Errorf("no parameters found in: %T: %v", argumentError, argumentError)
		return
	}
	iter := &paramListIterator{params: params, max: len(params)}

	if verrorComponent, verrorOperation, returnErr = iter.preamble(); returnErr != nil {
		return
	}

	return
}

type paramListIterator struct {
	err      error
	idx, max int
	params   []interface{}
}

func (pl *paramListIterator) next() (interface{}, error) {
	if pl.err != nil {
		return nil, pl.err
	}
	if pl.idx+1 > pl.max {
		pl.err = fmt.Errorf("too few parameters: have %v", pl.max)
		return nil, pl.err
	}
	pl.idx++
	return pl.params[pl.idx-1], nil
}

func (pl *paramListIterator) preamble() (component, operation string, err error) {
	var tmp interface{}
	if tmp, err = pl.next(); err != nil {
		return
	}
	var ok bool
	if component, ok = tmp.(string); !ok {
		return "", "", fmt.Errorf("ParamList[0]: component name is not a string: %T", tmp)
	}
	if tmp, err = pl.next(); err != nil {
		return
	}
	if operation, ok = tmp.(string); !ok {
		return "", "", fmt.Errorf("ParamList[1]: operation name is not a string: %T", tmp)
	}
	return
}

var initializeVDLCalled bool

// initializeVDL performs vdl initialization.  It is safe to call multiple times.
// If you have an init ordering issue, just insert the following line verbatim
// into your source files in this package, right after the "package foo" clause:
//
//    var _ = initializeVDL()
//
// The purpose of this function is to ensure that vdl initialization occurs in
// the right order, and very early in the init sequence.  In particular, vdl
// registration and package variable initialization needs to occur before
// functions like vdl.TypeOf will work properly.
//
// This function returns a dummy value, so that it can be used to initialize the
// first var in the file, to take advantage of Go's defined init order.
func initializeVDL() struct{} {
	if initializeVDLCalled {
		return struct{}{}
	}
	initializeVDLCalled = true

	// Set error format strings.
	i18n.Cat().SetWithBase(i18n.LangID("en"), i18n.MsgID(ErrGlobMaxRecursionReached.ID), "{1:}{2:} max recursion level reached{:_}")
	i18n.Cat().SetWithBase(i18n.LangID("en"), i18n.MsgID(ErrGlobMatchesOmitted.ID), "{1:}{2:} some matches might have been omitted")
	i18n.Cat().SetWithBase(i18n.LangID("en"), i18n.MsgID(ErrGlobNotImplemented.ID), "{1:}{2:} Glob not implemented")

	return struct{}{}
}