Documentation
¶
Overview ¶
Package file provides filesystem actions for the operation graph.
Index ¶
- func Register(reg *op.ActionRegistry)
- type Backup
- type Copy
- type Exists
- type IsDir
- type Link
- type Mkdir
- type Move
- type Provider
- func (p *Provider) Backup(path, backupSuffix string) (result string, state map[string]any, retErr error)
- func (p *Provider) CompensateBackup(state any) error
- func (p *Provider) CompensateCopy(state any) error
- func (p *Provider) CompensateLink(state any) error
- func (p *Provider) CompensateMove(state any) error
- func (p *Provider) CompensateRemove(state any) error
- func (p *Provider) CompensateUnlink(state any) error
- func (p *Provider) CompensateWrite(state any) error
- func (p *Provider) Copy(path string, mode os.FileMode, content []byte) (checksum string, state map[string]any, retErr error)
- func (p *Provider) Exists(path string) (bool, error)
- func (p *Provider) IsDir(path string) (bool, error)
- func (p *Provider) Link(source, path string) (result string, state map[string]any, retErr error)
- func (p *Provider) Mkdir(path string, mode os.FileMode) (string, error)
- func (p *Provider) Move(gitMv func(src, dst string) error, source, path string) (result string, compState map[string]any, retErr error)
- func (p *Provider) Remove(path string, prune bool, pruneBoundary string) (result string, compState map[string]any, retErr error)
- func (p *Provider) Source(path string) ([]byte, error)
- func (p *Provider) Unlink(path string, prune bool, pruneBoundary string) (result string, compState map[string]any, retErr error)
- func (p *Provider) Write(content, path string, mode os.FileMode) (result string, compState map[string]any, retErr error)
- type Remove
- type Source
- type Unlink
- type Write
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Register ¶
func Register(reg *op.ActionRegistry)
Register registers all file actions with the given registry.
Types ¶
type Backup ¶
type Backup struct{ Impl *Provider }
Backup — Backup moves the file at path to a timestamped backup location. Returns the backup path and compensation state.
type Copy ¶
type Copy struct{ Impl *Provider }
Copy — Copy writes content to path with the given mode. Returns the SHA256 checksum of the written content and compensation state.
type Exists ¶
type Exists struct{ Impl *Provider }
Exists — Exists returns true if path exists on the filesystem.
type IsDir ¶
type IsDir struct{ Impl *Provider }
IsDir — IsDir returns true if path exists and is a directory.
type Link ¶
type Link struct{ Impl *Provider }
Link — Link creates a symlink at path pointing to source. Idempotent: if the symlink already points correctly, it's a no-op (returns nil state).
type Mkdir ¶
type Mkdir struct{ Impl *Provider }
Mkdir — Mkdir creates a directory (and parents) with the given mode.
type Move ¶
type Move struct{ Impl *Provider }
Move — Move moves a file from source to path. Uses gitMv if provided (preserves git history), falling back to os.Rename. Returns compensation state with paths for reverse move.
type Provider ¶
type Provider struct{}
Provider provides file system actions. Each method receives all inputs as parameters — no execution context, no node access.
Compensable Forward methods return (string, map[string]any, error): the resource path, the compensation receipt, and an error. The map is opaque to the executor, meaningful only to the corresponding Compensate* Backward method.
func (*Provider) Backup ¶
func (p *Provider) Backup(path, backupSuffix string) (result string, state map[string]any, retErr error)
Backup moves the file at path to a timestamped backup location. Returns the backup path and compensation state.
Parameters:
- path: Absolute path to the file to back up
- backupSuffix: Suffix appended before the timestamp (default: .writ-backup)
+devlore:access=planned
func (*Provider) CompensateBackup ¶
CompensateBackup undoes a Backup by moving the backup back to the original path.
func (*Provider) CompensateCopy ¶
CompensateCopy undoes a Copy action using the captured state.
func (*Provider) CompensateLink ¶
CompensateLink undoes a Link action using the captured state.
func (*Provider) CompensateMove ¶
CompensateMove undoes a Move by moving the file back from path to source.
func (*Provider) CompensateRemove ¶
CompensateRemove undoes a Remove by re-creating the file with saved content and mode.
func (*Provider) CompensateUnlink ¶
CompensateUnlink undoes an Unlink by re-creating the symlink.
func (*Provider) CompensateWrite ¶
CompensateWrite undoes a Write action using the captured state.
func (*Provider) Copy ¶
func (p *Provider) Copy(path string, mode os.FileMode, content []byte) (checksum string, state map[string]any, retErr error)
Copy writes content to path with the given mode. Returns the SHA256 checksum of the written content and compensation state.
Parameters:
- path: Absolute path where the file will be written
- mode: File permission bits (e.g., 0o644)
+devlore:access=planned
func (*Provider) Exists ¶
Exists returns true if path exists on the filesystem.
Parameters:
- path: Absolute path to check
+devlore:access=both
func (*Provider) IsDir ¶
IsDir returns true if path exists and is a directory.
Parameters:
- path: Absolute path to check
+devlore:access=both
func (*Provider) Link ¶
Link creates a symlink at path pointing to source. Idempotent: if the symlink already points correctly, it's a no-op (returns nil state).
Parameters:
- source: Absolute path to the symlink target
- path: Absolute path where the symlink will be created
+devlore:access=planned
func (*Provider) Mkdir ¶
Mkdir creates a directory (and parents) with the given mode.
Parameters:
- path: Absolute path of the directory to create
- mode: Directory permission bits (e.g., 0o755)
+devlore:access=planned
func (*Provider) Move ¶
func (p *Provider) Move(gitMv func(src, dst string) error, source, path string) (result string, compState map[string]any, retErr error)
Move moves a file from source to path. Uses gitMv if provided (preserves git history), falling back to os.Rename. Returns compensation state with paths for reverse move.
Parameters:
- source: Absolute path to the file to move
- path: Absolute destination path
+devlore:access=planned
func (*Provider) Remove ¶
func (p *Provider) Remove(path string, prune bool, pruneBoundary string) (result string, compState map[string]any, retErr error)
Remove deletes the file at path. If prune is true and pruneBoundary is set, empty parent directories are removed up to the boundary. Returns compensation state with file content for re-creation.
Parameters:
- path: Absolute path to the file to delete
- prune: If true, remove empty parent directories after deletion
- pruneBoundary: Stop pruning at this directory (prevents removing too much)
+devlore:access=planned
func (*Provider) Source ¶
Source reads a file and returns its contents.
Parameters:
- path: Absolute path to the file to read
+devlore:access=planned
func (*Provider) Unlink ¶
func (p *Provider) Unlink(path string, prune bool, pruneBoundary string) (result string, compState map[string]any, retErr error)
Unlink removes a symlink at path. If prune is true and pruneBoundary is set, empty parent directories are removed up to the boundary. Returns compensation state with the symlink target for re-creation.
Parameters:
- path: Absolute path to the symlink to remove
- prune: If true, remove empty parent directories after unlinking
- pruneBoundary: Stop pruning at this directory (prevents removing too much)
+devlore:access=planned
func (*Provider) Write ¶
func (p *Provider) Write(content, path string, mode os.FileMode) (result string, compState map[string]any, retErr error)
Write writes inline content to path with the given mode. Returns compensation state for undo.
Parameters:
- content: String content to write to the file
- path: Absolute path where the file will be written
- mode: File permission bits (e.g., 0o644)
+devlore:access=planned
type Remove ¶
type Remove struct{ Impl *Provider }
Remove — Remove deletes the file at path. If prune is true and pruneBoundary is set, empty parent directories are removed up to the boundary. Returns compensation state with file content for re-creation.
type Source ¶
type Source struct{ Impl *Provider }
Source — Source reads a file and returns its contents.
type Unlink ¶
type Unlink struct{ Impl *Provider }
Unlink — Unlink removes a symlink at path. If prune is true and pruneBoundary is set, empty parent directories are removed up to the boundary. Returns compensation state with the symlink target for re-creation.
Source Files