package kspec

// IResult -- возвращаемый результат.
type IResult[T any] interface {
	// IsOk -- возвращает true, если Result содержит значение.
	IsOk() bool
	// IsErr -- возвращает true, если Result содержит ошибку.
	IsErr() bool
	// Ok -- возвращает значение, если оно есть, иначе паникует.
	Ok() T
	// OkOr -- возвращает значение, если оно есть, или значение по умолчанию.
	OkOr(defaultValue T) T
	// OkOrFn -- возвращает значение, если оно есть, или результат выполнения функции.
	OkOrFn(fn func() T) T
	// Err -- возвращает ошибку, если она есть.
	Err() error
	// Error -- возвращает строковое представление ошибки, если она есть.
	Error() string
	// Hassert -- проверяет, что нет ошибки (с паникой).
	Hassert(msgFormat string, args ...any) T
	// Assert -- проверяет, что нет ошибки (с паникой только на локальном стенде).
	Assert(msgFormat string, args ...any) T
}