errs

README

errs

Simple module for uniform format of errors returned by web-api

Простейший вспомогательный модуль, единственное назначение которого - упрощение единообразной регистрации сообщений об ошибках.

Плоский ассоциативный массив списков ошибок, ориентированный но ключи вида a[15].b.c[3].

Documentation

Overview

Package errs реализует очень простой механизм единообразного формата ошибок, возвращаемых web-api.

Index

• func SetDelimiter(s string)
• type Errors
  • func (err *Errors) Add(key string, msg ...string) *Errors
  • func (err *Errors) AddErrors(prefix string, add Errors) *Errors

Functions

func SetDelimiter

func SetDelimiter(s string)

SetDelimiter устанавливает используемый при слиянии Errors разделитель между ключом добавляемой ошибки и приписываемым слева к этому ключу префиксом.

Types

type Errors

type Errors map[string][]string

Errors определяет тип хранилища ошибок: ключ идентифицирует сущность, к которой относятся ошибки, массив строк - информация об ошибках, относящихся к этой сущности.

func (*Errors) Add

func (err *Errors) Add(key string, msg ...string) *Errors

Add добавляет ошибки с текстами msg к сущности с ключом key

func (*Errors) AddErrors

func (err *Errors) AddErrors(prefix string, add Errors) *Errors

AddErrors добавляет информацию из хранилища add к хранилищу err. Если добавляемый ключ - пустая строка, в качестве нового ключа используется префикс prefix. Иначе к ключу слева дописывается префикс+разделитель и полученная строка используется как новый ключ.

Это позволяет сформировать удобный для обработки путь к ошибочному элементу, состоящий из имён полей и индексов массивов.