Documentation
¶
Overview ¶
Package batch contains internal utilities for interacting with message batches.
Package batch contains internal utilities for interacting with message batches.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
Error is an error type that also allows storing granular errors for each message of a batch.
func NewError ¶
NewError creates a new batch-wide error, where it's possible to add granular errors for individual messages of the batch.
func (*Error) Failed ¶
Failed stores an error state for a particular message of a batch. Returns a pointer to the underlying error, allowing with method to be chained.
If Failed is not called then all messages are assumed to have failed. If it is called at least once then all message indexes that aren't explicitly failed are assumed to have been processed successfully.
func (*Error) IndexedErrors ¶
IndexedErrors returns the number of indexed errors that have been registered for the batch.
func (*Error) WalkParts ¶
WalkParts applies a closure to each message that was part of the request that caused this error. The closure is provided the message part index, a pointer to the part, and its individual error, which may be nil if the message itself was processed successfully. The closure returns a bool which indicates whether the iteration should be continued.
Source Files