tower

type Caller interface {
	// Function returns the function information.
	Function() *runtime.Func
	// Name returns the function name of the caller.
	Name() string
	// ShortName returns only function name of the caller.
	ShortName() string
	// ShortSource returns only the latest three items path in the File Path where the Caller comes from.
	ShortSource() string
	// String Sets this caller as `file_path:line` format.
	String() string
	// Line returns the line number of the caller.
	Line() int
	// File returns the file path of the caller.
	File() string
	// PC returns the program counter of the caller.
	PC() uintptr
	// FormatAsKey Like .String(), but runes other than letters, digits, `-` and `.` are set to `_`.
	FormatAsKey() string
}

type CallerHint interface {
	// Caller returns the caller of this type.
	Caller() Caller
}

type CodeBlockJSONMarshaler interface {
	CodeBlockJSON() ([]byte, error)
}

type CodeHint interface {
	// Gets the original code of the type.
	Code() int
}

type ContextHint interface {
	// Context returns the context of this type.
	Context() []any
}

type Display interface {
	// Display returns a human-readable and rich with information for the implementer.
	Display() string
}

type DisplayWriter interface {
	// WriteDisplay Writes the Display() string to the writer instead of being allocated as value.
	WriteDisplay(w LineWriter)
}

type Entry interface {
	CallerHint
	CodeHint
	ContextHint
	HTTPCodeHint
	KeyHint
	LevelHint
	MessageHint
	ServiceHint
	TimeHint

	/*
		Logs this entry.
	*/
	Log(ctx context.Context) Entry
	/*
		Notifies this entry to Messengers.
	*/
	Notify(ctx context.Context, opts ...MessageOption) Entry
}

type EntryBuilder interface {
	// Code Sets the code for this entry.
	Code(i int) EntryBuilder

	// Message Sets the message for this entry.
	//
	// In built in implementation, If args are supplied, fmt.Sprintf will be called with s as base string.
	//
	// Very unlikely you will need to set this, because tower already create the message field for you when you call tower.NewEntry.
	Message(s string, args ...any) EntryBuilder

	// Context Sets additional data that will enrich how the entry will look.
	//
	// `tower.Fields` is a type that is more integrated with built-in Messengers.
	// Using this type as Context value will often have special treatments for it.
	//
	// In built-in implementation, additional call to .Context() will make additional index, not replacing what you already set.
	//
	// Example:
	//
	// 	tower.NewEntry(msg).Code(200).Context(tower.F{"foo": "bar"}).Freeze()
	Context(ctx ...any) EntryBuilder

	// Key Sets the key for this entry. This is how Messenger will use to identify if an entry is the same as previous or not.
	//
	// In tower's built-in implementation, by default, no key is set when creating new entry.
	//
	// Usually by not setting the key, The Messenger will generate their own key for this message.
	//
	// In built in implementation, If args are supplied, fmt.Sprintf will be called with key as base string.
	Key(key string, args ...any) EntryBuilder

	// Caller Sets the caller for this entry.
	//
	// In tower's built-in implementation, by default, the caller is the location where you call `tower.NewEntry`.
	Caller(c Caller) EntryBuilder

	// Time Sets the time for this entry. By default, it's already set when you call tower.NewEntry.
	Time(time.Time) EntryBuilder

	/*
		Sets the level for this entry.

		In tower's built-in implementation, this defaults to what method you call to generate this entry.
	*/
	Level(lvl Level) EntryBuilder

	/*
		Freeze this entry. Preventing further mutations.
	*/
	Freeze() Entry
	/*
		Log this entry. Implicitly calling .Freeze() method.
	*/
	Log(ctx context.Context) Entry

	/*
		Sends this Entry to Messengers. Implicitly calling .Freeze() method.
	*/
	Notify(ctx context.Context, opts ...MessageOption) Entry
}

type EntryConstructor interface {
	ConstructEntry(*EntryConstructorContext) EntryBuilder
}

type EntryConstructorContext struct {
	Caller  Caller
	Message string
	Tower   *Tower
}

type EntryConstructorFunc func(*EntryConstructorContext) EntryBuilder

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

type Error interface {
	error
	CallerHint
	CodeHint
	ContextHint
	ErrorUnwrapper
	ErrorWriter
	HTTPCodeHint
	KeyHint
	LevelHint
	MessageHint
	TimeHint
	ServiceHint

	/*
		Logs this error.
	*/
	Log(ctx context.Context) Error
	/*
		Notifies this error to Messengers.
	*/
	Notify(ctx context.Context, opts ...MessageOption) Error
}

type ErrorBuilder interface {
	/*
		Sets the error code for this error.
		This is used to identify the error type and how towerhttp will interact with this error.

		The default implementation for Tower handles code like this:

		The default value, if anything in the error implements CodeHint interface,
		use the outermost CodeHint implementer, otherwise fallsback to 500.

		`tower.Error` that is generated by tower implements CodeHinter interface,
		and thus if the error is wrapped again, the default code for this error will be the code of the wrapped `tower.Error`.

		Example:

			if err != nil {
				return tower.Wrap(err).Code(500).Freeze()
			}
	*/
	Code(i int) ErrorBuilder

	/*
		Overrides the error message for this error.

		In built in implementation, If args are supplied, fmt.Sprintf will be called with s as base string.
	*/
	Message(s string, args ...any) ErrorBuilder

	/*
		Sets the origin error for ErrorBuilder. Very unlikely to need to set this because tower.Wrap already wraps the error.
		But the api is available to set the origin error.
	*/
	Error(err error) ErrorBuilder

	/*
		Sets additional data that will enrich how the error will look.

		`tower.Fields` is a type that is well integrated with built-in Messengers.
		Using this type as Context value will have the performance more optimized when being marshaled
		or provides additional quality of life improvements without having to implement those features
		yourself. Use `tower.F` as alias for this type.

		In built-in implementation, additional call to .Context() will make additional index, not replacing what you already set.

		Example:

			tower.Wrap(err).Code(400).Context(tower.F{"foo": "bar"}).Freeze()
	*/
	Context(ctx ...any) ErrorBuilder

	/*
		Sets the key for this error. This is how Messenger will use to identify if an error is the same as previous or not.

		In tower's built-in implementation, by default, no key is set.

		Usually by not setting the key, The Messenger will generate their own.

		In built in implementation, If args are supplied, fmt.Sprintf will be called with key as base string.
	*/
	Key(key string, args ...any) ErrorBuilder

	/*
		Sets the caller for this error.

		In tower's built-in implementation, by default, the caller is the location where you call `tower.Wrap` or `tower.WrapFreeze`
	*/
	Caller(c Caller) ErrorBuilder

	/*
		Sets the level for this error.

		In tower's built-in implementation, this defaults to ErrorLevel if not set.
	*/
	Level(lvl Level) ErrorBuilder

	/*
		Sets the time for this error.

		In tower's built-in implementation, this is already set to when tower.Wrap is called.
	*/
	Time(t time.Time) ErrorBuilder

	/*
		Freeze this ErrorBuilder, preventing further mutations and set this ErrorBuilder into proper error.

		The returned Error is safe for multithreaded usage because of its immutable nature.
	*/
	Freeze() Error

	/*
		Logs this error. Implicitly calls .Freeze() on this ErrorBuilder.
	*/
	Log(ctx context.Context) Error
	/*
		Notifies this error to Messengers. Implicitly calls .Freeze() on this ErrorBuilder.
	*/
	Notify(ctx context.Context, opts ...MessageOption) Error
}

type ErrorConstructor interface {
	ConstructError(*ErrorConstructorContext) ErrorBuilder
}

type ErrorConstructorContext struct {
	Err    error
	Caller Caller
	Tower  *Tower
}

type ErrorConstructorFunc func(*ErrorConstructorContext) ErrorBuilder

type ErrorMessageContextBuilder interface {
	BuildErrorMessageContext(err Error, param MessageParameter) MessageContext
}

type ErrorMessageContextBuilderFunc func(err Error, param MessageParameter) MessageContext

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

type ErrorUnwrapper interface {
	// Unwrap Returns the error that is wrapped by this error. To be used by errors.Is and errors.As functions from errors library.
	Unwrap() error
}

type ErrorWriter interface {
	// WriteError Writes the error.Error to the writer instead of being allocated as value.
	WriteError(w LineWriter)
}

type F = Fields

type Fields map[string]any

type Float interface {
	~float32 | ~float64
}

type HTTPCodeHint interface {
	// Gets HTTP Status Code for the type.
	HTTPCode() int
}

type Integer interface {
	Signed | Unsigned
}

type KeyHint interface {
	// Key returns the key for this type.
	Key() string
}

type KeyValue[K, V any] struct {
	Key   K
	Value V
}

type Level int8

type LevelHint interface {
	// Level returns the level of this type.
	Level() Level
}

type LineWriter interface {
	io.Writer
	io.StringWriter
	// WriteNewLine Writes a predetermined new line character(s) to the writer.
	WriteLineBreak()
	// WritePrefix Writes a predetermined prefix to the writer.
	WritePrefix()
	// WriteSuffix Writes a predetermined suffix to the writer.
	WriteSuffix()
	// WriteIndent Writes Indentation characters.
	WriteIndent()
	// GetLineBreak Returns the pre-determined line break characters.
	GetLineBreak() string
	// GetPrefix Returns the pre-determined prefix.
	GetPrefix() string
	// GetSuffix Returns the pre-determined suffix.
	GetSuffix() string
	// GetIndentation Returns the pre-determined indentation.
	GetIndentation() string
}

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

type Logger interface {
	Log(ctx context.Context, entry Entry)
	LogError(ctx context.Context, err Error)
}

type MessageContext interface {
	HTTPCodeHint
	CodeHint
	MessageHint
	CallerHint
	KeyHint
	LevelHint
	ServiceHint
	ContextHint
	TimeHint
	// Err returns the error item. May be nil if message contains no error.
	Err() error
	// SkipVerification If true, Sender asks for this message to always be send.
	SkipVerification() bool
	// Cooldown returns non-zero value if Sender asks for this message to be sent after this duration.
	Cooldown() time.Duration
	// Tower Gets the tower instance that created this MessageContext.
	Tower() *Tower
}

type MessageContextBuilder interface {
	BuildMessageContext(entry Entry, param MessageParameter) MessageContext
}

type MessageContextBuilderFunc func(entry Entry, param MessageParameter) MessageContext

type MessageHint interface {
	// Message returns the message of the type.
	Message() string
}

type MessageOption interface {
	// contains filtered or unexported methods
}

type MessageOptionFunc func(*messageOption)

type MessageParameter interface {
	SkipVerification() bool
	Cooldown() time.Duration
	Tower() *Tower
}

type Messenger interface {
	// Returns the name of the Messenger.
	Name() string
	// Sends notification.
	SendMessage(ctx context.Context, msg MessageContext)

	// Waits until all message in the queue or until given channel is received.
	//
	// Implementer must exit the function as soon as possible when this ctx is canceled.
	Wait(ctx context.Context) error
}

type Messengers map[string]Messenger

type NoopLogger struct{}

type NoopTracer struct{}

type Ordered interface {
	Integer | Float | ~string
}

type Service struct {
	Name        string `json:"name,omitempty"`
	Environment string `json:"environment,omitempty"`
	Repository  string `json:"repository,omitempty"`
	Branch      string `json:"branch,omitempty"`
	Type        string `json:"type,omitempty"`
	Version     string `json:"version,omitempty"`
}

type ServiceHint interface {
	// Service returns the service information.
	Service() Service
}

type Signed interface {
	~int | ~int8 | ~int16 | ~int32 | ~int64
}

type Summary interface {
	// Summary Returns a short summary of the implementer.
	Summary() string
}

type SummaryWriter interface {
	// WriteSummary Writes the Summary() string to the writer instead of being allocated as value.
	WriteSummary(w LineWriter)
}

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

type TimeHint interface {
	// Time returns the time of this type.
	Time() time.Time
}

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

type Trace []KeyValue[string, string]

type TraceCaptureFunc func(ctx context.Context) Trace

type TraceCapturer interface {
	CaptureTrace(ctx context.Context) Trace
}

type Unsigned interface {
	~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr
}