README
¶
file adaptor
The file adaptor reads/writes data to the defined locations.
NOTE
This adaptor is primarily used for testing purposes.
Configuration:
- stdout:
type: file
uri: stdout://
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var (
DefaultURI = "stdout://"
)
DefaultURI is the default file, outputs to stdout
Functions ¶
This section is empty.
Types ¶
type Client ¶ added in v0.2.0
type Client struct {
// contains filtered or unexported fields
}
Client represents a client to the underlying File source.
func NewClient ¶ added in v0.2.0
func NewClient(options ...ClientOptionFunc) (*Client, error)
NewClient creates a default file client
type ClientOptionFunc ¶ added in v0.2.0
ClientOptionFunc is a function that configures a Client. It is used in NewClient.
func WithURI ¶ added in v0.2.0
func WithURI(uri string) ClientOptionFunc
WithURI defines the full path to the file, prefixed with file://, or stdout://
type Config ¶
type Config struct {
URI string `json:"uri" doc:"the uri to connect to, ie stdout://, file:///tmp/output"`
}
Config is used to configure the File Adaptor
type File ¶
type File struct {
// contains filtered or unexported fields
}
File is an adaptor that can be used as a source / sink for file's on disk, as well as a sink to stdout.
type Reader ¶ added in v0.2.0
type Reader struct{}
Reader implements the behavior defined by client.Reader for interfacing with the file.
func (*Reader) Read ¶ added in v0.2.0
func (r *Reader) Read(filterFn client.NsFilterFunc) client.MessageChanFunc
Source Files
Click to show internal directories.
Click to hide internal directories.