reserved

Documentation

Overview

Package reserved implements client-side support for reserved RPC methods implemented by all servers.

Index

• Variables
• func ErrorfGlobMatchesOmitted(ctx *context.T, format string) error
• func ErrorfGlobMaxRecursionReached(ctx *context.T, format string) error
• func ErrorfGlobNotImplemented(ctx *context.T, format string) error
• func MessageGlobMatchesOmitted(ctx *context.T, message string) error
• func MessageGlobMaxRecursionReached(ctx *context.T, message string) error
• func MessageGlobNotImplemented(ctx *context.T, message string) error
• func MethodSignature(ctx *context.T, name, method string, opts ...rpc.CallOpt) (signature.Method, error)
• func NewErrGlobMatchesOmitted(ctx *context.T) error
• func NewErrGlobMaxRecursionReached(ctx *context.T) error
• func NewErrGlobNotImplemented(ctx *context.T) error
• func ParamsErrGlobMatchesOmitted(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)
• func ParamsErrGlobMaxRecursionReached(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)
• func ParamsErrGlobNotImplemented(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)
• func Signature(ctx *context.T, name string, opts ...rpc.CallOpt) ([]signature.Interface, error)

Variables

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

Functions

func ErrorfGlobMatchesOmitted

func ErrorfGlobMatchesOmitted(ctx *context.T, format string) error

ErrorfGlobMatchesOmitted calls ErrGlobMatchesOmitted.Errorf with the supplied arguments.

func ErrorfGlobMaxRecursionReached

func ErrorfGlobMaxRecursionReached(ctx *context.T, format string) error

ErrorfGlobMaxRecursionReached calls ErrGlobMaxRecursionReached.Errorf with the supplied arguments.

func ErrorfGlobNotImplemented

func ErrorfGlobNotImplemented(ctx *context.T, format string) error

ErrorfGlobNotImplemented calls ErrGlobNotImplemented.Errorf with the supplied arguments.

func MessageGlobMatchesOmitted

func MessageGlobMatchesOmitted(ctx *context.T, message string) error

MessageGlobMatchesOmitted calls ErrGlobMatchesOmitted.Message with the supplied arguments.

func MessageGlobMaxRecursionReached

func MessageGlobMaxRecursionReached(ctx *context.T, message string) error

MessageGlobMaxRecursionReached calls ErrGlobMaxRecursionReached.Message with the supplied arguments.

func MessageGlobNotImplemented

func MessageGlobNotImplemented(ctx *context.T, message string) error

MessageGlobNotImplemented calls ErrGlobNotImplemented.Message with the supplied arguments.

func MethodSignature

func MethodSignature(ctx *context.T, name, method string, opts ...rpc.CallOpt) (signature.Method, error)

MethodSignature invokes the reserved method signature RPC on the given name, and returns the results.

func NewErrGlobMatchesOmitted

func NewErrGlobMatchesOmitted(ctx *context.T) error

NewErrGlobMatchesOmitted returns an error with the ErrGlobMatchesOmitted ID. Deprecated: this function will be removed in the future, use ErrorfGlobMatchesOmitted or MessageGlobMatchesOmitted instead.

func NewErrGlobMaxRecursionReached

func NewErrGlobMaxRecursionReached(ctx *context.T) error

NewErrGlobMaxRecursionReached returns an error with the ErrGlobMaxRecursionReached ID. Deprecated: this function will be removed in the future, use ErrorfGlobMaxRecursionReached or MessageGlobMaxRecursionReached instead.

func NewErrGlobNotImplemented

func NewErrGlobNotImplemented(ctx *context.T) error

NewErrGlobNotImplemented returns an error with the ErrGlobNotImplemented ID. Deprecated: this function will be removed in the future, use ErrorfGlobNotImplemented or MessageGlobNotImplemented instead.

func ParamsErrGlobMatchesOmitted

func ParamsErrGlobMatchesOmitted(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)

ParamsErrGlobMatchesOmitted extracts the expected parameters from the error's ParameterList.

func ParamsErrGlobMaxRecursionReached

func ParamsErrGlobMaxRecursionReached(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)

ParamsErrGlobMaxRecursionReached extracts the expected parameters from the error's ParameterList.

func ParamsErrGlobNotImplemented

func ParamsErrGlobNotImplemented(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)

ParamsErrGlobNotImplemented extracts the expected parameters from the error's ParameterList.

func Signature

func Signature(ctx *context.T, name string, opts ...rpc.CallOpt) ([]signature.Interface, error)

Signature invokes the reserved signature RPC on the given name, and returns the results.