Documentation ¶
Overview ¶
Package gerrc extends the canonical google API design guideline errors with cosmos sdk registration.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrCancelled : The operation was cancelled, typically by the caller. ErrCancelled = registerAndWrap(0, gerr.ErrCancelled) // ErrUnknown : Unknown error. For example, this error may be returned when // a `Status` value received from another address space belongs to // an error space that is not known in this address space. Also // errors raised by APIs that do not return enough error information // may be converted to this error. ErrUnknown = registerAndWrap(1, gerr.ErrUnknown) // ErrInvalidArgument : The client specified an invalid argument. Note that this differs // from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments // that are problematic regardless of the state of the system // (e.g., a malformed file name). ErrInvalidArgument = registerAndWrap(2, gerr.ErrInvalidArgument) // ErrDeadlineExceeded : The deadline expired before the operation could complete. For operations // that change the state of the system, this error may be returned // even if the operation has completed successfully. For example, a // successful response from a server could have been delayed long // enough for the deadline to expire. ErrDeadlineExceeded = registerAndWrap(3, gerr.ErrDeadlineExceeded) // ErrNotFound : Some requested entity (e.g., file or directory) was not found. ErrNotFound = registerAndWrap(4, gerr.ErrNotFound) // ErrAlreadyExists : The entity that a client attempted to create (e.g., file or directory) // already exists. ErrAlreadyExists = registerAndWrap(5, gerr.ErrAlreadyExists) // ErrPermissionDenied : The caller does not have permission to execute the specified // operation. `PERMISSION_DENIED` must not be used for rejections // caused by exhausting some resource (use `RESOURCE_EXHAUSTED` // instead for those errors). `PERMISSION_DENIED` must not be // used if the caller can not be identified (use `UNAUTHENTICATED` // instead for those errors). This error code does not imply the // request is valid or the requested entity exists or satisfies // other pre-conditions. ErrPermissionDenied = registerAndWrap(6, gerr.ErrPermissionDenied) // ErrUnauthenticated : The request does not have valid authentication credentials for the // operation. ErrUnauthenticated = registerAndWrap(7, gerr.ErrUnauthenticated) // ErrResourceExhausted : Some resource has been exhausted, perhaps a per-user quota, or // perhaps the entire file system is out of space. ErrResourceExhausted = registerAndWrap(8, gerr.ErrResourceExhausted) // ErrFailedPrecondition : The operation was rejected because the system is not in a state // required for the operation's execution. For example, the directory // to be deleted is non-empty, an rmdir operation is applied to // a non-directory, etc. // // Service implementors can use the following guidelines to decide // between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: // // (a) Use `UNAVAILABLE` if the client can retry just the failing call. // (b) Use `ABORTED` if the client should retry at a higher level. For // example, when a client-specified test-and-set fails, indicating the // client should restart a read-modify-write sequence. // (c) Use `FAILED_PRECONDITION` if the client should not retry until // the system state has been explicitly fixed. For example, if an "rmdir" // fails because the directory is non-empty, `FAILED_PRECONDITION` // should be returned since the client should not retry unless // the files are deleted from the directory. ErrFailedPrecondition = registerAndWrap(9, gerr.ErrFailedPrecondition) // ErrAborted : The operation was aborted, typically due to a concurrency issue such as // a sequencer check failure or transaction abort. ErrAborted = registerAndWrap(10, gerr.ErrAborted) // ErrOutOfRange : The operation was attempted past the valid range. E.g., seeking or // reading past end-of-file. // // Unlike `INVALID_ARGUMENT`, this error indicates a problem that may // be fixed if the system state changes. For example, a 32-bit file // system will generate `INVALID_ARGUMENT` if asked to read at an // offset that is not in the range [0,2^32-1], but it will generate // `OUT_OF_RANGE` if asked to read from an offset past the current // file size. // // There is a fair bit of overlap between `FAILED_PRECONDITION` and // `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific // error) when it applies so that callers who are iterating through // a space can easily look for an `OUT_OF_RANGE` error to detect when // they are done. ErrOutOfRange = registerAndWrap(11, gerr.ErrOutOfRange) // ErrUnimplemented : The operation is not implemented or is not supported/enabled in this // service. ErrUnimplemented = registerAndWrap(12, gerr.ErrUnimplemented) // ErrInternal : Internal errors. This means that some invariants expected by the // underlying system have been broken. This error code is reserved // for serious errors. ErrInternal = registerAndWrap(13, gerr.ErrInternal) // transient condition, which can be corrected by retrying with // a backoff. Note that it is not always safe to retry // non-idempotent operations. // // See the guidelines above for deciding between `FAILED_PRECONDITION`, // `ABORTED`, and `UNAVAILABLE`. ErrUnavailable = registerAndWrap(14, gerr.ErrUnavailable) // ErrDataLoss : Unrecoverable data loss or corruption. ErrDataLoss = registerAndWrap(15, gerr.ErrDataLoss) // ErrFault is a failed precondition error for malicious actor faults or frauds. ErrFault = errorsmod.Wrap(ErrFailedPrecondition, "fraud or fault") )
View Source
var DefaultCodespace = "gerrc"
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.