package multierror

Import Path
	github.com/hashicorp/go-multierror (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 2 packages

Involved Source Files

	      append.go
	      flatten.go
	      format.go
	      multierror.go
	      prefix.go
	      sort.go
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Error (struct)
		Error is an error type to track multiple errors. This is used to
		accumulate errors in cases and return them as a single "error".

		Fields (total 2, both are exported)
			ErrorFormat ErrorFormatFunc
			Errors []error
		Methods (total 7, all are exported)
			(*T) Error() string
			(*T) ErrorOrNil() error
				ErrorOrNil returns an error interface if this Error represents
				a list of errors, or returns nil if the list of errors is empty. This
				function is useful at the end of accumulation to make sure that the value
				returned represents the existence of errors.

			(*T) GoString() string
			( T) Len() int
				Len implements sort.Interface function for length

			( T) Less(i, j int) bool
				Less implements sort.Interface function for determining order

			( T) Swap(i, j int)
				Swap implements sort.Interface function for swapping elements

			(*T) WrappedErrors() []error
				WrappedErrors returns the list of errors that this Error is wrapping.
				It is an implementation of the errwrap.Wrapper interface so that
				multierror.Error can be used with that library.

				This method is not safe to be called concurrently and is no different
				than accessing the Errors field directly. It is implemented only to
				satisfy the errwrap.Wrapper interface.

		Implements (at least 5, in which 4 are exported)
			*T : github.com/hashicorp/errwrap.Wrapper
			*T : error
			*T : fmt.GoStringer
			 T : sort.Interface
			/* at least one unexported ... *//* at least one unexported: */
			 T : github.com/aws/aws-sdk-go/aws/corehandlers.lener
		As Outputs Of (at least one exported)
			func Append(err error, errs ...error) *Error
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func flatten(err error, flatErr *Error)

	 type ErrorFormatFunc (func)
		ErrorFormatFunc is a function callback that is called by Error to
		turn the list of errors into a string.



Package-Level Functions (total 5, in which 4 are exported)

	 func Append(err error, errs ...error) *Error
		Append is a helper function that will append more errors
		onto an Error in order to create a larger multi-error.

		If err is not a multierror.Error, then it will be turned into
		one. If any of the errs are multierr.Error, they will be flattened
		one level into err.

	 func Flatten(err error) error
		Flatten flattens the given error, merging any *Errors together into
		a single *Error.

	 func ListFormatFunc(es []error) string
		ListFormatFunc is a basic formatter that outputs the number of errors
		that occurred along with a bullet point list of the errors.

	 func Prefix(err error, prefix string) error
		Prefix is a helper function that will prefix some text
		to the given error. If the error is a multierror.Error, then
		it will be prefixed to each wrapped error.

		This is useful to use when appending multiple multierrors
		together in order to give better scoping.

	/* one unexported ... *//* one unexported: */
	 func flatten(err error, flatErr *Error)

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.