5d664855de
This adds the requirement that all function implementations provider a String() string method so that these can be used as vertices in the pgraph library. If we eventually move to generics for the pgraph DAG, then this might not matter, but it's not bad that these have names either.
86 lines
2.4 KiB
Go
86 lines
2.4 KiB
Go
// Mgmt
|
|
// Copyright (C) 2013-2022+ James Shubin and the project contributors
|
|
// Written by James Shubin <james@shubin.ca> and the project contributors
|
|
//
|
|
// 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 facts
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/purpleidea/mgmt/lang/interfaces"
|
|
"github.com/purpleidea/mgmt/lang/types"
|
|
)
|
|
|
|
// FactFunc is a wrapper for the fact interface. It implements the fact
|
|
// interface in terms of Func to reduce the two down to a single mechanism.
|
|
type FactFunc struct { // implements `interfaces.Func`
|
|
Fact Fact
|
|
}
|
|
|
|
// String returns a simple name for this function. This is needed so this struct
|
|
// can satisfy the pgraph.Vertex interface.
|
|
func (obj *FactFunc) String() string {
|
|
return obj.Fact.String()
|
|
}
|
|
|
|
// Validate makes sure we've built our struct properly.
|
|
func (obj *FactFunc) Validate() error {
|
|
if obj.Fact == nil {
|
|
return fmt.Errorf("must specify a Fact in struct")
|
|
}
|
|
//return obj.Fact.Validate() // currently unused
|
|
return nil
|
|
}
|
|
|
|
// Info returns some static info about itself.
|
|
func (obj *FactFunc) Info() *interfaces.Info {
|
|
return &interfaces.Info{
|
|
Pure: false,
|
|
Memo: false,
|
|
Sig: &types.Type{
|
|
Kind: types.KindFunc,
|
|
// if Ord or Map are nil, this will panic things!
|
|
Ord: []string{},
|
|
Map: make(map[string]*types.Type),
|
|
Out: obj.Fact.Info().Output,
|
|
},
|
|
Err: obj.Fact.Info().Err,
|
|
}
|
|
}
|
|
|
|
// Init runs some startup code for this fact.
|
|
func (obj *FactFunc) Init(init *interfaces.Init) error {
|
|
return obj.Fact.Init(
|
|
&Init{
|
|
Hostname: init.Hostname,
|
|
Output: init.Output,
|
|
World: init.World,
|
|
Debug: init.Debug,
|
|
Logf: init.Logf,
|
|
},
|
|
)
|
|
}
|
|
|
|
// Stream returns the changing values that this function has over time.
|
|
func (obj *FactFunc) Stream() error {
|
|
return obj.Fact.Stream()
|
|
}
|
|
|
|
// Close runs some shutdown code for this function and turns off the stream.
|
|
func (obj *FactFunc) Close() error {
|
|
return obj.Fact.Close()
|
|
}
|