Categorygithub.com/codepope/transporteradaptorfile
package
0.2.1
Repository: https://github.com/codepope/transporter.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
13
Dependents
0
Files
275 SLOC

# 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://

# Functions

NewClient creates a default file client.
WithURI defines the full path to the file, prefixed with file://, or stdout://.

# Variables

DefaultURI is the default file, outputs to stdout.

# Structs

Client represents a client to the underlying File source.
Config is used to configure the File Adaptor.
File is an adaptor that can be used as a source / sink for file's on disk, as well as a sink to stdout.
Reader implements the behavior defined by client.Reader for interfacing with the file.
Session serves as a wrapper for the underlying file.
Writer implements client.Writer for use with Files.

# Type aliases

ClientOptionFunc is a function that configures a Client.