aboutsummaryrefslogtreecommitdiff
path: root/libpod/events/nullout.go
blob: da3820c23c235ca565eb0867bf9abc75a35f946b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package events

import (
	"context"
	"errors"
)

// EventToNull is an eventer type that does nothing.
// It is meant for unittests only
type EventToNull struct{}

// Write eats the event and always returns nil
func (e EventToNull) Write(ee Event) error {
	return nil
}

// Read does nothing and returns an error.
func (e EventToNull) Read(ctx context.Context, options ReadOptions) error {
	return errors.New("cannot read events with the \"none\" backend")
}

// newNullEventer returns a new null eventer.  You should only do this for
// the purposes of internal libpod testing.
func newNullEventer() Eventer {
	return EventToNull{}
}

// String returns a string representation of the logger
func (e EventToNull) String() string {
	return "none"
}