Mercurial > gemma
diff pkg/common/warn.go @ 4171:5a650cde0574
Move warning limiter to common package to flesh up the misc package.
The remaining stuff in misc has dependencies to the config
and cannot be removed from there easily w/o introducing
cyclic imports. I have to rethink this.
| author | Sascha L. Teichmann <sascha.teichmann@intevation.de> |
|---|---|
| date | Mon, 05 Aug 2019 16:43:31 +0200 |
| parents | pkg/misc/warn.go@6e748f31777a |
| children | 6270951dda28 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/pkg/common/warn.go Mon Aug 05 16:43:31 2019 +0200 @@ -0,0 +1,39 @@ +// This is Free Software under GNU Affero General Public License v >= 3.0 +// without warranty, see README.md and license for details. +// +// SPDX-License-Identifier: AGPL-3.0-or-later +// License-Filename: LICENSES/AGPL-3.0.txt +// +// Copyright (C) 2019 by via donau +// – Österreichische Wasserstraßen-Gesellschaft mbH +// Software engineering by Intevation GmbH +// +// Author(s): +// * Sascha L. Teichmann <sascha.teichmann@intevation.de> + +package common + +// WarningLimiter limits outputs with Log to a maximal number +// of MaxWarnings outputs. +type WarningLimiter struct { + Log func(format string, args ...interface{}) + MaxWarnings int + Warnings int +} + +// Warn is a wrapper around the Log function with the +// same signature as the Log function so it can be used +// instead. +func (w *WarningLimiter) Warn(format string, args ...interface{}) { + if w.Warnings++; w.Warnings <= w.MaxWarnings { + w.Log(format, args...) + } +} + +// Close can be called to write a final message if the limit +// was reached. +func (w *WarningLimiter) Close() { + if w.Warnings > w.MaxWarnings { + w.Log("Too many warnings. %d ignored.", w.Warnings-w.MaxWarnings) + } +}