# Functions
Cause walks all the preceding errors and return the originating error.
ForceLog should rarely be used.
MethodFactoryMarker returns a special marker Factory object.
NewError creates a simple string error (like Error.New).
NewHTTPResponse is typically called by a Policy object to return a Response object.
NewPipeline creates a new goroutine-safe Pipeline object from the slice of Factory objects and the specified options.
NewRequest initializes a new HTTP request object with any desired options.
NewRequestBodyProgress adds progress reporting to an HTTP request's body stream.
NewResponseBodyProgress adds progress reporting to an HTTP response's body stream.
SetForceLogEnabled can be used to disable ForceLog There is no threadsafety or locking on the underlying variable, so call this function just once at startup of your application (Don't later try to change the setting on the fly).
SetLogSanitizer can be called to supply a custom LogSanitizer.
WriteRequestWithResponse appends a formatted HTTP request into a Buffer.
# Constants
LogDebug tells a logger to log all LogDebug, LogInfo, LogWarning, LogError, LogPanic and LogFatal entries passed to it.
LogError tells a logger to log all LogError, LogPanic and LogFatal entries passed to it.
LogFatal tells a logger to log all LogFatal entries passed to it.
LogInfo tells a logger to log all LogInfo, LogWarning, LogError, LogPanic and LogFatal entries passed to it.
LogNone tells a logger not to log any entries passed to it.
LogPanic tells a logger to log all LogPanic and LogFatal entries passed to it.
LogWarning tells a logger to log all LogWarning, LogError, LogPanic and LogFatal entries passed to it.
UserAgent is the string to be used in the user agent string when making requests.
Version is the semantic version (see http://semver.org) of the pipeline package.
# Structs
ErrorNode can be an embedded field in a private error object.
ErrorNodeNoCause can be an embedded field in a private error object.
LogOptions configures the pipeline's logging mechanism & level filtering.
Options configures a Pipeline's behavior.
A PolicyOptions represents optional information that can be used by a node in the linked-list of Policy objects.
Request is a thin wrapper over an http.Request.
# Interfaces
The Factory interface represents an object that can create its Policy object.
LogSanitizer can be implemented to clean secrets from lines logged by ForceLog By default no implemetation is provided here, because pipeline may be used in many different contexts, so the correct implementation is context-dependent.
The Pipeline interface represents an ordered list of Factory objects and an object implementing the HTTPSender interface.
The Policy interface represents a mutable Policy object created by a Factory.
The Response interface exposes an http.Response object as it returns through the pipeline of Policy objects.
# Type aliases
FactoryFunc is an adapter that allows the use of an ordinary function as a Factory interface.
LogLevel tells a logger the minimum level to log.
PolicyFunc is an adapter that allows the use of an ordinary function as a Policy interface.
ProgressReceiver defines the signature of a callback function invoked as progress is reported.