Documentation
¶
Index ¶
- Variables
- type Factory
- func (f *Factory) GetOrCreateProvider(ctx op.Context) op.ContextProvider
- func (f *Factory) NewPlanning(graph *op.Graph, project string, registry *op.ActionRegistry) starlark.Value
- func (f *Factory) ProviderType() reflect.Type
- func (f *Factory) ReceiverName() string
- func (f *Factory) Register(registry *op.ActionRegistry, ctx op.Context)
Constants ¶
This section is empty.
Variables ¶
View Source
var Params = op.MethodParams{
"Root": {},
"Backup": {"path", "backup_suffix"},
"Copy": {"source_file", "destination_filename", "destination_file_mode"},
"Link": {"source", "path"},
"Move": {"source", "destination"},
"Remove": {"path", "prune", "boundary"},
"RemoveAll": {"path", "prune", "boundary"},
"Unlink": {"path", "prune", "boundary"},
"WalkTree": {"root?", "fn", "honor_gitignore?"},
"WriteBytes": {"destination", "content", "mode"},
"WriteText": {"destination", "content", "mode"},
"Exists": {"resource"},
"Glob": {"pattern", "honor_gitignore"},
"IsDir": {"resource"},
"IsFile": {"resource"},
"Mkdir": {"resource", "mode"},
"Read": {"path"},
"Join": {"*parts"},
"Name": {"path"},
"Parent": {"path"},
}
Params maps Go method names to Starlark parameter name lists.
View Source
var Receiver op.ReceiverFactory = &Factory{}
Receiver is the ReceiverFactory for the file provider.
Functions ¶
This section is empty.
Types ¶
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
Factory implements op.ReceiverFactory for the file provider.
func (*Factory) GetOrCreateProvider ¶
func (f *Factory) GetOrCreateProvider(ctx op.Context) op.ContextProvider
GetOrCreateProvider returns a cached provider for the given context, creating one if needed. The provider is invalidated when the Root changes.
Parameters:
- ctx: the execution context providing Root and platform state.
Returns:
- op.ContextProvider: the provider instance.
func (*Factory) NewPlanning ¶
func (f *Factory) NewPlanning(graph *op.Graph, project string, registry *op.ActionRegistry) starlark.Value
NewPlanning creates a Starlark receiver that records method calls as graph nodes.
Parameters:
- graph: the operation graph to populate.
- project: the project identifier.
- registry: the action registry for node creation.
Returns:
- starlark.Value: the planning receiver.
func (*Factory) ProviderType ¶
ProviderType returns the reflect.Type of the underlying provider struct.
Returns:
- reflect.Type: the provider's concrete type.
func (*Factory) ReceiverName ¶
ReceiverName returns the Starlark receiver name for this provider.
Returns:
- string: the receiver name "file".
Source Files
Click to show internal directories.
Click to hide internal directories.