initial import

Author: lp117937

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Xerra Earth Observation Institute
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1 @@
+## Docs coming soon...

go.mod

@@ -0,0 +1,3 @@
+module gitlab.com/xerra/common/sharederror
+
+go 1.15

shared_error.go

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) 2021, Xerra Earth Observation Institute
+ * All rights reserved. Use is subject to License terms.
+ * See LICENSE.TXT in the root directory of this source tree.
+ */
+
+package sharederror
+
+import (
+	"fmt"
+	"sync"
+)
+
+// SharedError implements goroutine-safe error handling.
+// Multiple concurrent goroutines can share a SharedError variable to reports errors
+// to the calling function.
+type SharedError struct {
+	err []error
+	lock sync.Mutex
+}
+
+// Error implements the error interface, you can return a SharedError as an error.
+func (s *SharedError) Error() string {
+	s.lock.Lock()
+	defer s.lock.Unlock()
+
+	if len(s.err) == 0 {
+		return ""
+	}
+
+	if len(s.err) == 1 {
+		return s.err[0].Error()
+	}
+
+	errorStr := ""
+
+	for i, err := range s.err {
+		if i != 0 {
+			errorStr += " / "
+		}
+
+		errorStr += fmt.Sprintf("error %d: %v", i, err)
+	}
+
+	return errorStr
+}
+
+// Triggered returns true if an error is stored in the ShareError, or false for no error.
+func (s *SharedError) Triggered() bool {
+	s.lock.Lock()
+	defer s.lock.Unlock()
+
+	if len(s.err) == 0 {
+		return false
+	}
+
+	return true
+}
+
+// Store stores an error condition in SharedError.
+func (s *SharedError) Store(err error) {
+	if err == nil {
+		return
+	}
+
+	s.lock.Lock()
+	defer s.lock.Unlock()
+
+	s.err = append(s.err, err)
+}