Categorygithub.com/IBM/go-security-plugsiofilter
package
1.3.20
Repository: https://github.com/ibm/go-security-plugs.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
3
Dependents
1
Files
163 SLOC

# README

iofilter

Enables adding a filter to any io.ReadCloser.

Given an exiting 'provider' that publishes an io.ReadCloser interface

A caller may call:

  • provider.Read(p []byte) (n int, err error) and
  • provider.Close() error use:

To examin and filter the data transfered use:

  newProvider = iofilter.New(provider, filter)

The newProvider offers an io.ReadCloser interface. The data is sent to filter before it is provided to the newProvider.

If the filter returns an error or panics, the data is discarded and no more data is transfered.

# Functions

Create a New iofilter to wrap an existing provider of an io.ReadCloser interface The new iofilter will expose an io.ReadCloser interface The data will be sent to filter before it is delivered The optional params may include a two integer parameter indicating: 1.

# Structs

An Iofilter object maintining internal buffers and state.