drop.go

package writer

import (
	"time"

	"github.com/Jeffail/benthos/v3/lib/log"
	"github.com/Jeffail/benthos/v3/lib/metrics"
	"github.com/Jeffail/benthos/v3/lib/types"
)

//------------------------------------------------------------------------------

// DropConfig contains configuration fields for the drop output type.
type DropConfig struct{}

// NewDropConfig creates a new DropConfig with default values.
func NewDropConfig() DropConfig {
	return DropConfig{}
}

//------------------------------------------------------------------------------

// Drop is a benthos writer.Type implementation that writes message parts to no
// where.
type Drop struct {
	log log.Modular
}

// NewDrop creates a new file based writer.Type.
func NewDrop(
	conf DropConfig,
	log log.Modular,
	stats metrics.Type,
) *Drop {
	return &Drop{
		log: log,
	}
}

// Connect is a noop.
func (d *Drop) Connect() error {
	d.log.Infoln("Dropping messages.")
	return nil
}

// Write does nothing.
func (d *Drop) Write(msg types.Message) error {
	return nil
}

// CloseAsync begins cleaning up resources used by this reader asynchronously.
func (d *Drop) CloseAsync() {
}

// WaitForClose will block until either the reader is closed or a specified
// timeout occurs.
func (d *Drop) WaitForClose(time.Duration) error {
	return nil
}

//------------------------------------------------------------------------------