Repository navigation
Expand file tree
/
Copy patherrors.go
More file actions
62 lines (57 loc) · 2.58 KB
/
Copy patherrors.go
File metadata and controls
62 lines (57 loc) · 2.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
package kivik
import (
internal "github.com/go-kivik/kivik/v4/int/errors"
)
const (
// ErrClientClosed is returned by any client operations after [Client.Close]
// has been called.
ErrClientClosed = internal.CompositeError("503 client closed")
// ErrDatabaseClosed is returned by any database operations after [DB.Close]
// has been called.
ErrDatabaseClosed = internal.CompositeError("503 database closed")
// Various not-implemented errors, that are returned, but don't need to be exposed directly.
errFindNotImplemented = internal.CompositeError("501 driver does not support Find interface")
errClusterNotImplemented = internal.CompositeError("501 driver does not support cluster operations")
errOpenRevsNotImplemented = internal.CompositeError("501 driver does not support OpenRevs interface")
errSecurityNotImplemented = internal.CompositeError("501 driver does not support Security interface")
errConfigNotImplemented = internal.CompositeError("501 driver does not support Config interface")
errReplicationNotImplemented = internal.CompositeError("501 driver does not support replication")
errNoAttachments = internal.CompositeError("404 no attachments")
)
// HTTPStatus returns the HTTP status code embedded in the error, or 500
// (internal server error), if there was no specified status code. If err is
// nil, HTTPStatus returns 0. This provides a convenient way to determine the
// precise nature of a Kivik-returned error.
//
// For example, to panic for all but NotFound errors:
//
// err := db.Get(context.TODO(), "docID").ScanDoc(&doc)
// if kivik.HTTPStatus(err) == http.StatusNotFound {
// return
// }
// if err != nil {
// panic(err)
// }
//
// This method uses the statusCoder interface, which is not exported by this
// package, but is considered part of the stable public API. Driver
// implementations are expected to return errors which conform to this
// interface.
//
// type statusCoder interface {
// HTTPStatus() int
// }
func HTTPStatus(err error) int {
return internal.HTTPStatus(err)
}