ledge

type BlockingEntryReader interface {
	// Entries returns all Entry objects in the order they were read.
	Entries() ([]*Entry, error)
}

type Context interface{}

type Decoder interface {
	// Decode gets the next marshalled Entry object from the input stream.
	Decode(reader *bufio.Reader) ([]byte, error)
}

type Encoder interface {
	// Encode encodes marshalled byte slices to a writer, optionally adding output.
	Encode(writer io.Writer, p []byte) (int, error)
}

type Entry struct {
	// ID is a unique ID that is assocated with this Entry, usually a UUID except in testing.
	// This must be globally unique across multiple instances of a Logger.
	ID string
	// Time is the time that this Entry was logged.
	Time time.Time
	// Level is the Level of this entry.
	Level Level
	// Contexts is the contexts that were associated with the Logger when this entry was logged.
	Contexts []Context
	// Event is the event that was logged.
	Event Event
	// WriterOutput is the associated writer output, if this Entry was used for a Writer function.
	// If this Entry was created from a non-Writer function, this will be nil.
	WriterOutput []byte
}

type EntryReader interface {
	// Channel returns a read channel of EntryResponse objects.
	Channel() <-chan *EntryResponse
	// Cancel cancels reading and will close the channel.
	Cancel() error
}

type EntryReaderOptions struct {
	// Filters specifies the Filters to use.
	Filters []Filter
}

type EntryResponse struct {
	// Entry is the Entry read.
	Entry *Entry
	// Error will be set if there was an error reading.
	Error error
}

type ErrorEvent struct {
	Msg string `protobuf:"bytes,1,opt,name=msg" json:"msg,omitempty"`
}

type Event interface{}

type FakeLogger interface {
	Logger
	BlockingEntryReader

	// AddTimeSec adds the specified number of seconds to the fake Timer.
	AddTimeSec(int64)

	// CheckEntriesEqual returns error if the expected Entry objects do not match the logged Entry objects.
	CheckEntriesEqual(expected []*Entry, checkID bool, checkTime bool) error
}

type Fields map[string]interface{}

type Filter interface {
	// Include returns true if the Entry should be included.
	Include(entry *Entry) bool
}

type IDAllocator interface {
	// Allocate allocates a new unique ID.
	Allocate() string
}

type Level int32

type Logger interface {
	// WithContext returns a new Logger with the given Context attached. If the Context
	// was not registered in the Specification on Logger creation, this method will panic.
	WithContext(context Context) Logger
	// Unstructured returns the associated UnstructuredLogger. The methods on UnstructuredLogger
	// are not directly included on Logger to discourage use of these methods.
	Unstructured() UnstructuredLogger

	// Debug prints an event at the Debug Level.
	Debug(event Event)
	// Error prints an event at the Error Level.
	Error(event Event)
	// Fatal prints an event at the Fatal Level.
	Fatal(event Event)
	// Info prints an event at the Info Level.
	Info(event Event)
	// Panic prints an event at the Panic Level.
	Panic(event Event)
	// Warn prints an event at the Warn Level.
	Warn(event Event)
	// DebugWriter returns a new io.Writer that will log output to the writer
	// inside the WriterOutput field of an Entry, using the associated Event,
	// at the Debug Level.
	DebugWriter(event Event) io.Writer
	// ErrorWriter returns a new io.Writer that will log output to the writer
	// inside the WriterOutput field of an Entry, using the associated Event,
	// at the Error Level.
	ErrorWriter(event Event) io.Writer
	// InfoWriter returns a new io.Writer that will log output to the writer
	// inside the WriterOutput field of an Entry, using the associated Event,
	// at the Info Level.
	InfoWriter(event Event) io.Writer
	// WarnWriter returns a new io.Writer that will log output to the writer
	// inside the WriterOutput field of an Entry, using the associated Event,
	// at the Warn Level.
	WarnWriter(event Event) io.Writer

	// ErrorEvent is a convienence method that calls Error using an ErrorEvent
	// if err is not nil.
	ErrorEvent(err error)
}

type LoggerOptions struct {
	// IDAllocator specifies an alternate IDAllocator to use.
	// If not specified, a UUID allocator will be used.
	IDAllocator IDAllocator
	// Time specifies an alternate Timer to use.
	// If not specification, a system Timer will be used.
	Timer Timer
	// Filters specifies the Filters to use.
	Filters []Filter
	// Encoder specifies an Encoder to use.
	// If not specified, no encoder will be used and marshalled Entry objects
	// will be directed printed to the Logger's io.Writer with a newline added.
	Encoder Encoder
	// BackupWriter specifes a backup location to write errors to if there
	// are errors writing to the main io.Writer specified on Logger creation.
	// Otherwise, we have a recursive problem - how do you log an error for a log error?
	BackupWriter io.Writer
}

type Marshaller interface {
	// Marshal marshals Entry objects into byte slices.
	Marshal(entry *Entry) ([]byte, error)
}

type ProtoEntry struct {
	Id                       string            `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	TimeUnixNsec             int64             `protobuf:"varint,2,opt,name=time_unix_nsec,json=timeUnixNsec" json:"time_unix_nsec,omitempty"`
	Level                    Level             `protobuf:"varint,3,opt,name=level,enum=ledge.Level" json:"level,omitempty"`
	ContextTypeNameToContext map[string][]byte `` /* 213-byte string literal not displayed */
	EventTypeName            string            `protobuf:"bytes,5,opt,name=event_type_name,json=eventTypeName" json:"event_type_name,omitempty"`
	Event                    []byte            `protobuf:"bytes,6,opt,name=event,proto3" json:"event,omitempty"`
	WriterOutput             []byte            `protobuf:"bytes,7,opt,name=writer_output,json=writerOutput,proto3" json:"writer_output,omitempty"`
}

type Specification struct {
	ContextTypes []Context
	EventTypes   []Event
}

type TextMarshallerOptions struct {
	// NoID will suppress the printing of Entry IDs.
	NoID bool
	// NoTime will suppress the printing of Entry times.
	NoTime bool
	// NoLevel will suppress the printing of Entry Levels.
	NoLevel bool
	// NoContexts will suppress the printing of Entry Contexts.
	NoContexts bool
}

type Timer interface {
	// Now returns the current time.
	Now() time.Time
}

type Unmarshaller interface {
	// Unmarshal unmarshals a byte slice into an Entry.
	Unmarshal(p []byte) (*Entry, error)
}

type UnstructuredEvent struct {
	Msg string `protobuf:"bytes,1,opt,name=msg" json:"msg,omitempty"`
}

type UnstructuredLogger interface {
	// WithField returns a new UnstructuredLogger with the given field value.
	WithField(key string, value interface{}) UnstructuredLogger
	// WithField returns a new UnstructuredLogger with the given Fields.
	WithFields(fields Fields) UnstructuredLogger

	// Debug prints a Debug event, analogous to fmt.Sprint.
	Debug(args ...interface{})
	// Debugf prints a Debug event, analogous to fmt.Sprintf.
	Debugf(format string, args ...interface{})
	// Debugln prints a Debug event, analogous to fmt.Sprintln.
	Debugln(args ...interface{})
	// Error prints an Error event, analogous to fmt.Sprint.
	Error(args ...interface{})
	// Errorf prints an Error event, analogous to fmt.Sprintf.
	Errorf(format string, args ...interface{})
	// Errorln prints an Error event, analogous to fmt.Sprintln.
	Errorln(args ...interface{})
	// Fatal prints a Fatal event, analogous to fmt.Sprint. It then exits with os.Exit(1).
	Fatal(args ...interface{})
	// Fatalf prints a Fatal event, analogous to fmt.Sprintf. It then exits with os.Exit(1).
	Fatalf(format string, args ...interface{})
	// Fatalln prints a Fatal event, analogous to fmt.Sprintln. It then exits with os.Exit(1).
	Fatalln(args ...interface{})
	// Info prints an Info event, analogous to fmt.Sprint.
	Info(args ...interface{})
	// Infof prints an Info event, analogous to fmt.Sprintf.
	Infof(format string, args ...interface{})
	// Infoln prints an Info event, analogous to fmt.Sprintln.
	Infoln(args ...interface{})
	// Panic with a Panic event, analogous to fmt.Sprint.
	Panic(args ...interface{})
	// Panic with a Panic event, analogous to fmt.Sprintf.
	Panicf(format string, args ...interface{})
	// Panic a Panic event, analogous to fmt.Sprintln.
	Panicln(args ...interface{})
	// Print is an alias for Info.
	Print(args ...interface{})
	// Printf is an alias for Infof.
	Printf(format string, args ...interface{})
	// Println is an alias for Infoln.
	Println(args ...interface{})
	// Warn prints a Warn event, analogous to fmt.Sprint.
	Warn(args ...interface{})
	// Warnf prints a Warn event, analogous to fmt.Sprintf.
	Warnf(format string, args ...interface{})
	// Warnln prints a Warn event, analogous to fmt.Sprintln.
	Warnln(args ...interface{})

	// DebugWriter returns a new io.Writer that will log output to the writer
	// inside the WriterOutput field of an Entry at the Debug Level.
	DebugWriter() io.Writer
	// ErrorWriter returns a new io.Writer that will log output to the writer
	// inside the WriterOutput field of an Entry at the Error Level.
	ErrorWriter() io.Writer
	// InfoWriter returns a new io.Writer that will log output to the writer
	// inside the WriterOutput field of an Entry at the Info Level.
	InfoWriter() io.Writer
	// WarnWriter returns a new io.Writer that will log output to the writer
	// inside the WriterOutput field of an Entry at the Warn Level.
	WarnWriter() io.Writer
}