mrmsg

Documentation

Index

• func CheckRender(message string) error
• func MustRender(message string, vars map[string]string) string
• func MustRenderWithData(message string, data Data) string
• func MustRenderWithNamedArgs(message string, args []NamedArg) string
• func ParseArgsNames(message string) []string
• func Render(message string, vars map[string]string) (string, error)
• func RenderWithData(message string, data Data) (string, error)
• func RenderWithNamedArgs(message string, args []NamedArg) (string, error)
• func ToString(value any) string
• type Data
  • func (d Data) String() string
  • func (d Data) ValueString(key string) string
• type ErrorMessage
  • func (m *ErrorMessage) DetailsToString() string
• type NamedArg
  • func (a *NamedArg) ValueString() string

Functions

func CheckRender

func CheckRender(message string) error

CheckRender - если указанное сообщение содержит параметры, то проверяется их корректность.

func MustRender

func MustRender(message string, vars map[string]string) string

MustRender - возвращает сформированное сообщение со вставленными в него значениями переменных. В случае ошибки логирует причину и возвращает сообщение без вставленных переменных.

func MustRenderWithData

func MustRenderWithData(message string, data Data) string

MustRenderWithData - возвращает сформированное сообщение со вставленными в него данными. В случае ошибки логирует причину и возвращает сообщение без вставленных данных.

func MustRenderWithNamedArgs

func MustRenderWithNamedArgs(message string, args []NamedArg) string

MustRenderWithNamedArgs - возвращает сформированное сообщение со вставленными в него именованными параметрами. В случае ошибки логирует причину и возвращает сообщение без вставленных параметров.

func ParseArgsNames

func ParseArgsNames(message string) []string

ParseArgsNames - извлечение параметров из указанного сообщения.

func Render

func Render(message string, vars map[string]string) (string, error)

Render - возвращает сформированное сообщение со вставленными в него значениями переменных.

func RenderWithData

func RenderWithData(message string, data Data) (string, error)

RenderWithData - возвращает сформированное сообщение со вставленными в него данными.

func RenderWithNamedArgs

func RenderWithNamedArgs(message string, args []NamedArg) (string, error)

RenderWithNamedArgs - возвращает сформированное сообщение со вставленными в него именованными параметрами.

func ToString

func ToString(value any) string

ToString - преобразовывает значение аргумента в строку.

Types

type Data

type Data map[string]any

Data - произвольные данные с возможностью их отображения в виде строки.

func (Data) String

func (d Data) String() string

String - преобразовывает данные в строку.

func (Data) ValueString

func (d Data) ValueString(key string) string

ValueString - возвращает значение в виде строки для указанного ключа. Если ключ не найден, то возвращается пустая строка.

type ErrorMessage

type ErrorMessage struct {
	Reason  string   `yaml:"reason"`
	Details []string `yaml:"details"`
}

ErrorMessage - сообщение об ошибке с её деталями.

func (*ErrorMessage) DetailsToString

func (m *ErrorMessage) DetailsToString() string

DetailsToString - преобразовывает список деталей ошибки в строку.

type NamedArg

type NamedArg struct {
	Name  string
	Value any
}

NamedArg - именованный аргумент используемый в сообщениях.

func (*NamedArg) ValueString

func (a *NamedArg) ValueString() string

ValueString - преобразовывает значение аргумента в строку.