Documentation
¶
Index ¶
- func ListDirectoryTool() spec.Tool
- func MIMEForExtensionTool() spec.Tool
- func MIMEForPathTool() spec.Tool
- func ReadFile(ctx context.Context, args ReadFileArgs) ([]spec.ToolStoreOutputUnion, error)
- func ReadFileTool() spec.Tool
- func SearchFilesTool() spec.Tool
- func StatPathTool() spec.Tool
- type ListDirectoryArgs
- type ListDirectoryOut
- type MIMEDetectMethod
- type MIMEForExtensionArgs
- type MIMEForExtensionOut
- type MIMEForPathArgs
- type MIMEForPathOut
- type MIMEMode
- type ReadFileArgs
- type SearchFilesArgs
- type SearchFilesOut
- type StatPathArgs
- type StatPathOut
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ListDirectoryTool ¶
func MIMEForExtensionTool ¶ added in v0.4.0
func MIMEForPathTool ¶ added in v0.4.0
func ReadFile ¶
func ReadFile(ctx context.Context, args ReadFileArgs) ([]spec.ToolStoreOutputUnion, error)
ReadFile reads a file from disk and returns its contents. If Encoding == "binary" the output is base64-encoded.
func ReadFileTool ¶
func SearchFilesTool ¶
func StatPathTool ¶
Types ¶
type ListDirectoryArgs ¶
type ListDirectoryOut ¶
type ListDirectoryOut struct {
Entries []string `json:"entries"`
}
func ListDirectory ¶
func ListDirectory(ctx context.Context, args ListDirectoryArgs) (*ListDirectoryOut, error)
ListDirectory lists files / dirs in Path. If Pattern is supplied, the results are filtered via filepath.Match.
type MIMEDetectMethod ¶ added in v0.4.0
type MIMEDetectMethod string
const ( MIMEDetectMethodExtension MIMEDetectMethod = "extension" MIMEDetectMethodSniff MIMEDetectMethod = "sniff" )
type MIMEForExtensionArgs ¶ added in v0.4.0
type MIMEForExtensionArgs struct {
Extension string `json:"extension"`
}
type MIMEForExtensionOut ¶ added in v0.4.0
type MIMEForExtensionOut struct {
Extension string `json:"extension"`
NormalizedExtension string `json:"normalizedExtension"`
MIMEType string `json:"mimeType"`
BaseMIMEType string `json:"baseMimeType"`
Mode MIMEMode `json:"mode"`
Known bool `json:"known"`
}
func MIMEForExtension ¶ added in v0.4.0
func MIMEForExtension(ctx context.Context, args MIMEForExtensionArgs) (*MIMEForExtensionOut, error)
MIMEForExtension returns the best-known MIME type for an extension.
If the extension is unknown, this tool returns: - mimeType: "application/octet-stream" - known: false and does NOT error (so calling code can continue).
type MIMEForPathArgs ¶ added in v0.4.0
type MIMEForPathArgs struct {
Path string `json:"path"`
}
type MIMEForPathOut ¶ added in v0.4.0
type MIMEForPathOut struct {
Path string `json:"path"`
Extension string `json:"extension,omitempty"`
NormalizedExtension string `json:"normalizedExtension,omitempty"`
MIMEType string `json:"mimeType"`
BaseMIMEType string `json:"baseMimeType"`
Mode MIMEMode `json:"mode"`
Method MIMEDetectMethod `json:"method"`
}
func MIMEForPath ¶ added in v0.4.0
func MIMEForPath(ctx context.Context, args MIMEForPathArgs) (*MIMEForPathOut, error)
MIMEForPath returns a best-effort MIME type for a filesystem path.
Notes: - If the extension maps to a non-generic MIME type, it may succeed even if the file does not exist. - If the extension is unknown/generic, it tries to open and sniff the file (can error if unreadable).
type ReadFileArgs ¶
type SearchFilesArgs ¶
type SearchFilesOut ¶
type SearchFilesOut struct {
Matches []string `json:"matches"`
}
func SearchFiles ¶
func SearchFiles(ctx context.Context, args SearchFilesArgs) (*SearchFilesOut, error)
SearchFiles walks Root (recursively) and returns up to MaxResults files whose *path* or *UTF-8 text content* match the supplied regexp.
type StatPathArgs ¶
type StatPathArgs struct {
Path string `json:"path"`
}
type StatPathOut ¶
type StatPathOut struct {
Path string `json:"path"`
Name string `json:"name"`
Exists bool `json:"exists"`
IsDir bool `json:"isDir"`
SizeBytes int64 `json:"sizeBytes,omitempty"`
ModTime *time.Time `json:"modTime,omitempty"`
}
func StatPath ¶
func StatPath(ctx context.Context, args StatPathArgs) (*StatPathOut, error)
StatPath returns basic metadata for the supplied path without mutating the file system.
Source Files