frostfs-node/pkg/local_object_storage/blobstor/delete_small.go
Leonard Lyubich 318639e5bf [#1247] *: Clarify docs about returned errors from apistatus package
`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>
2022-03-17 16:34:00 +03:00

23 lines
716 B
Go

package blobstor
// DeleteSmallPrm groups the parameters of DeleteSmall operation.
type DeleteSmallPrm struct {
address
rwBlobovniczaID
}
// DeleteSmallRes groups resulting values of DeleteSmall operation.
type DeleteSmallRes struct{}
// DeleteSmall removes object from blobovnicza of BLOB storage.
//
// If blobovnicza ID is not set or set to nil, BlobStor tries to
// find and remove object from any blobovnicza.
//
// Returns any error encountered that did not allow
// to completely remove the object.
//
// Returns an error of type apistatus.ObjectNotFound if there is no object to delete.
func (b *BlobStor) DeleteSmall(prm *DeleteSmallPrm) (*DeleteSmallRes, error) {
return b.blobovniczas.delete(prm)
}