grim/convey

Add documentation for the podman tasks
redux
2021-10-16, Gary Kramlich
fd65c6d6f2ab
Add documentation for the podman tasks
// Convey
// Copyright 2016-2018 Gary Kramlich <grim@reaperworld.com>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package tasks
import (
"github.com/go-yaml/yaml"
)
// CloneTask creates a task of the given type from the given payload. It
// does this by creating a fresh instance of a task of the target type,
// then marshalling/unmarshalling the payload to that type.
func Clone(task interface{}, taskType Task) (Task, error) {
rawTask, err := yaml.Marshal(task)
if err != nil {
return nil, err
}
realTask := taskType.New()
if err = yaml.Unmarshal(rawTask, realTask); err != nil {
return nil, err
}
return realTask, nil
}