maskingwriter

package module

v0.0.0-...-76a14f8 Latest Latest Go to latest Published: Jun 3, 2020 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Doszhan/masking-writer-go

Links

Open Source Insights

README ¶

masking-writer-go

Thread-safe writer for masking the defined set of strings

Documentation ¶

Index ¶

type Writer
- func New(writer io.WriteCloser, lock sync.Locker, ensureNewline bool, masking []string) *Writer
- func (writer *Writer) Close() error
- func (writer *Writer) Write(data []byte) (int, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Writer ¶

type Writer struct {
	// contains filtered or unexported fields
}

Writer implements writer, that will proxy to specified `backend` writer only complete lines, e.g. that ends in newline. This writer is thread-safe.

func New ¶

func New(
	writer io.WriteCloser,
	lock sync.Locker,
	ensureNewline bool,
	masking []string,
) *Writer

New returns new Writer, that will proxy data to the `backend` writer, thread-safety is guaranteed via `lock`. Optionally, writer can ensure, that last line of output ends with newline, if `ensureNewline` is true.

func (*Writer) Close ¶

func (writer *Writer) Close() error

Close flushes all remaining data and closes underlying backend writer. If `ensureNewLine` was specified and remaining data does not ends with newline, then newline will be added.

Signature matches with io.WriteCloser's Close().

func (*Writer) Write ¶

func (writer *Writer) Write(data []byte) (int, error)

Writer writes data into Writer.

Signature matches with io.Writer's Write().

Source Files ¶

View all Source files

masking_writer.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL