318639e5bf
`apistatus` package provides types which implement build-in `error` interface. Add `error of type` pattern when documenting these errors in order to clarify how these errors should be handled (e.g. `errors.Is` is not good). Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
33 lines
1.1 KiB
Go
33 lines
1.1 KiB
Go
package container
|
|
|
|
import (
|
|
"errors"
|
|
|
|
apistatus "github.com/nspcc-dev/neofs-sdk-go/client/status"
|
|
"github.com/nspcc-dev/neofs-sdk-go/container"
|
|
cid "github.com/nspcc-dev/neofs-sdk-go/container/id"
|
|
)
|
|
|
|
// Source is an interface that wraps
|
|
// basic container receiving method.
|
|
type Source interface {
|
|
// Get reads the container from the storage by identifier.
|
|
// It returns the pointer to requested container and any error encountered.
|
|
//
|
|
// Get must return exactly one non-nil value.
|
|
// Get must return an error of type apistatus.ContainerNotFound if the container is not in storage.
|
|
//
|
|
// Implementations must not retain the container pointer and modify
|
|
// the container through it.
|
|
Get(*cid.ID) (*container.Container, error)
|
|
}
|
|
|
|
// IsErrNotFound checks if error returned by Source.Get corresponds
|
|
// to missing container.
|
|
func IsErrNotFound(err error) bool {
|
|
return errors.As(err, new(apistatus.ContainerNotFound))
|
|
}
|
|
|
|
// ErrEACLNotFound is returned by eACL storage implementations when
|
|
// requested eACL table is not in storage.
|
|
var ErrEACLNotFound = errors.New("extended ACL table is not set for this container")
|