frostfs-sdk-go/client/errors.go

package client

import (
	"fmt"
)

// returns error describing missing field with the given name.
func newErrMissingResponseField(name string) error {
	return fmt.Errorf("missing %s field in the response", name)
}

// returns error describing invalid field (according to the NeoFS protocol)
// with the given name and format violation err.
func newErrInvalidResponseField(name string, err error) error {
	return fmt.Errorf("invalid %s field in the response: %w", name, err)
}
[#140] client: Specify status errors of `Client` methods Extend docs with supported status returns. Add several helper functions which allow to check the particular status. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru> 2022-02-28 10:56:46 +00:00			`package client`

[#278] client: Support wrapped errors in error checkers Client errors are quite often wrapped in context. When checking a specific error, it is required not to lose the ability to determine it, regardless of the attached context. In previous implementation `IsErr` functions didn't support wrapped errors. Make `IsErr` functions to preliminarily unwrap `error` argument before type assertion. Use `errors.Unwrap` for this instead of `errors.As` since the latter has the overhead of filling in an error. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru> 2022-06-27 07:39:20 +00:00			`import (`
[#299] client: Do not use pointers to required response fields In previous implementation `client` package provided access to nested response fields as pointers to them. This caused clients to handle nil cases even when the field presence in the response is required. Avoid returning pointers to required fields in response getters. This also reduces reference counter load and allows fields to be decoded directly without additional assignment. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru> 2022-08-05 07:56:49 +00:00			`"fmt"`
[#278] client: Support wrapped errors in error checkers Client errors are quite often wrapped in context. When checking a specific error, it is required not to lose the ability to determine it, regardless of the attached context. In previous implementation `IsErr` functions didn't support wrapped errors. Make `IsErr` functions to preliminarily unwrap `error` argument before type assertion. Use `errors.Unwrap` for this instead of `errors.As` since the latter has the overhead of filling in an error. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru> 2022-06-27 07:39:20 +00:00			`)`

[#299] client: Do not use pointers to required response fields In previous implementation `client` package provided access to nested response fields as pointers to them. This caused clients to handle nil cases even when the field presence in the response is required. Avoid returning pointers to required fields in response getters. This also reduces reference counter load and allows fields to be decoded directly without additional assignment. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru> 2022-08-05 07:56:49 +00:00			`// returns error describing missing field with the given name.`
			`func newErrMissingResponseField(name string) error {`
			`return fmt.Errorf("missing %s field in the response", name)`
			`}`

			`// returns error describing invalid field (according to the NeoFS protocol)`
			`// with the given name and format violation err.`
			`func newErrInvalidResponseField(name string, err error) error {`
			`return fmt.Errorf("invalid %s field in the response: %w", name, err)`
			`}`