filesystem

type DirEntry ¶

type DirEntry struct {
	Name    string
	Path    string
	IsDir   bool
	ModTime time.Time
}

type FindRequest ¶

type FindRequest struct {
	Pattern    string
	Path       string
	MaxResults int
}

type FindResult ¶

type FindResult struct {
	Paths     []string
	Truncated bool
	Text      string
	Hint      string
}

type GrepMatch ¶

type GrepMatch struct {
	Path    string
	Line    int
	Content string
}

type GrepRequest ¶

type GrepRequest struct {
	Pattern    string
	Path       string
	Glob       string
	IgnoreCase bool
	Literal    bool
	Context    int
	MaxMatches int
}

type GrepResult ¶

type GrepResult struct {
	Matches   []GrepMatch
	Truncated bool
	Text      string
	Hint      string
}

type Info ¶ added in v0.3.33

type Info struct {
	Name    string
	Path    string
	Size    int64
	IsDir   bool
	ModTime time.Time
}

Info is Stat metadata for a file or directory-like prefix.

type ReadFS ¶ added in v0.3.33

type ReadFS interface {
	Read(ctx context.Context, path string) ([]byte, error)
	Stat(ctx context.Context, path string) (Info, error)
	List(ctx context.Context, path string) ([]DirEntry, error)
}

ReadFS is the read/list surface. Remote and object-store backends implement directories as prefixes.

type SearchFS ¶ added in v0.3.33

type SearchFS interface {
	Grep(ctx context.Context, req GrepRequest) (GrepResult, error)
	Find(ctx context.Context, req FindRequest) (FindResult, error)
}

SearchFS is content and name search. Local disk walks the tree; S3 may list by prefix; a remote host may shell out to rg/find.

type Service ¶

type Service interface {
	ReadFS
	WriteFS
	SearchFS
}

Service is the file store injected into tool/fs-workspace and runtime plugins. Standard kind: filesystem/local. Alternate backends (memory, S3, remote) register as filesystem/<name> and are wired through deps.fs.

type WriteFS ¶ added in v0.3.33

type WriteFS interface {
	Write(ctx context.Context, path string, data []byte, opts ...WriteOption) error
	// Append adds data to the end of path, creating it when missing. Object
	// stores may implement it as read-modify-write.
	Append(ctx context.Context, path string, data []byte) error
}

WriteFS creates or replaces a file. Parent prefixes are created as needed (no-op on stores without directories).

type WriteOption ¶ added in v0.3.33

type WriteOption func(*WriteOptions)

WriteOption customizes a single Write call.

func WithPerm(perm os.FileMode) WriteOption

type WriteOptions ¶ added in v0.3.33

type WriteOptions struct {
	// Perm is the permission for newly created files. Zero keeps an existing
	// file's mode, or 0o644 for new files. Object stores ignore it.
	Perm os.FileMode
}

WriteOptions customizes a single Write call.