fileutil

package

v0.12.2 Latest Latest Go to latest Published: Nov 5, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/wavetermdev/waveterm

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func AddMimeTypeToFileInfo(path string, fileInfo *wshrpc.FileInfo)
func ApplyEdits(originalContent []byte, edits []EditSpec) ([]byte, error)
func DetectMimeType(path string, fileInfo fs.FileInfo, extended bool) string
func DetectMimeTypeWithDirEnt(path string, dirEnt fs.DirEntry) string
func FixPath(path string) (string, error)
func IsInitScriptPath(input string) bool
func ReplaceInFile(filePath string, edits []EditSpec) error
func WinSymlinkDir(path string, bits os.FileMode) bool
type DirEntryOut
type EditSpec
type FsFileInfo
- func ToFsFileInfo(fi *wshrpc.FileInfo) FsFileInfo
type ReadDirResult
- func ReadDir(path string, maxEntries int) (*ReadDirResult, error)
- func ReadDirRecursive(path string, maxEntries int) (*ReadDirResult, error)

Constants ¶

View Source

const (
	MaxEditFileSize = 5 * 1024 * 1024 // 5MB
)

Variables ¶

View Source

var StaticMimeTypeMap = map[string]string{}/* 1260 elements not displayed */

Functions ¶

func AddMimeTypeToFileInfo ¶ added in v0.11.1

func AddMimeTypeToFileInfo(path string, fileInfo *wshrpc.FileInfo)

func ApplyEdits ¶ added in v0.12.2

func ApplyEdits(originalContent []byte, edits []EditSpec) ([]byte, error)

ApplyEdits applies a series of edits to the given content and returns the modified content. Each edit's OldStr must appear exactly once in the content or an error is returned.

func DetectMimeType ¶

func DetectMimeType(path string, fileInfo fs.FileInfo, extended bool) string

on error just returns "" does not return "application/octet-stream" as this is considered a detection failure can pass an existing fileInfo to avoid re-statting the file falls back to text/plain for 0 byte files

func DetectMimeTypeWithDirEnt ¶ added in v0.11.1

func DetectMimeTypeWithDirEnt(path string, dirEnt fs.DirEntry) string

func FixPath ¶

func FixPath(path string) (string, error)

func IsInitScriptPath ¶

func IsInitScriptPath(input string) bool

IsInitScriptPath tries to determine if the input string is a path to a script rather than an inline script content.

func ReplaceInFile ¶ added in v0.12.2

func ReplaceInFile(filePath string, edits []EditSpec) error

func WinSymlinkDir ¶

func WinSymlinkDir(path string, bits os.FileMode) bool

Types ¶

type DirEntryOut ¶ added in v0.12.2

type DirEntryOut struct {
	Name         string `json:"name"`
	Dir          bool   `json:"dir,omitempty"`
	Symlink      bool   `json:"symlink,omitempty"`
	Size         int64  `json:"size,omitempty"`
	Mode         string `json:"mode"`
	Modified     string `json:"modified"`
	ModifiedTime string `json:"modified_time"`
}

type EditSpec ¶ added in v0.12.2

type EditSpec struct {
	OldStr string `json:"old_str"`
	NewStr string `json:"new_str"`
	Desc   string `json:"desc,omitempty"`
}

type FsFileInfo ¶ added in v0.11.1

type FsFileInfo struct {
	NameInternal    string
	ModeInternal    os.FileMode
	SizeInternal    int64
	ModTimeInternal int64
	IsDirInternal   bool
}

func ToFsFileInfo ¶ added in v0.11.1

func ToFsFileInfo(fi *wshrpc.FileInfo) FsFileInfo

ToFsFileInfo converts wshrpc.FileInfo to FsFileInfo. It panics if fi is nil.

func (FsFileInfo) IsDir ¶ added in v0.11.1

func (f FsFileInfo) IsDir() bool

func (FsFileInfo) ModTime ¶ added in v0.11.1

func (f FsFileInfo) ModTime() time.Time

func (FsFileInfo) Mode ¶ added in v0.11.1

func (f FsFileInfo) Mode() os.FileMode

func (FsFileInfo) Name ¶ added in v0.11.1

func (f FsFileInfo) Name() string

func (FsFileInfo) Size ¶ added in v0.11.1

func (f FsFileInfo) Size() int64

func (FsFileInfo) Sys ¶ added in v0.11.1

func (f FsFileInfo) Sys() interface{}

type ReadDirResult ¶ added in v0.12.2

type ReadDirResult struct {
	Path         string        `json:"path"`
	AbsolutePath string        `json:"absolute_path"`
	ParentDir    string        `json:"parent_dir,omitempty"`
	Entries      []DirEntryOut `json:"entries"`
	EntryCount   int           `json:"entry_count"`
	TotalEntries int           `json:"total_entries"`
	Truncated    bool          `json:"truncated,omitempty"`
}

func ReadDir ¶ added in v0.12.2

func ReadDir(path string, maxEntries int) (*ReadDirResult, error)

func ReadDirRecursive ¶ added in v0.12.2

func ReadDirRecursive(path string, maxEntries int) (*ReadDirResult, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL