osutil

package module

Go to main page

Versions in this module

v1

v1.7.1

Mar 16, 2025

v1.7.0

Mar 16, 2025

v1.6.1

Feb 15, 2025

v1.6.0

Feb 15, 2025

v1.5.0

Feb 10, 2025

v1.4.0

Feb 9, 2025

v1.3.0

Dec 18, 2024

Changes in this version

+ func CacheObjectRead(cachePath string, identifier string, cacheObjectType CacheObjectType, data any) (exists bool, err error)

+ func CacheObjectWrite(cachePath string, identifier string, cacheObjectType CacheObjectType, data any, ...) (err error)

+ func ContextWithInterrupt(ctx context.Context, logWriter io.Writer) (contextWithInterrupt context.Context, cancelContext context.CancelFunc)

+ func WriteFile(filePath string, content []byte) (err error)

+ type CacheObjectType string

+ type SyncedMap struct

+ func NewSyncedMap[K comparable, V any]() (syncedMap *SyncedMap[K, V])

+ func (m *SyncedMap[K, V]) Delete(key K)

+ func (m *SyncedMap[K, V]) Get(key K) (value V, ok bool)

+ func (m *SyncedMap[K, V]) Set(key K, value V)

v1.2.0

Apr 24, 2024

Changes in this version

+ func EnvironMap() (environMap map[string]string)

v1.1.0

Mar 29, 2024

v1.0.0

Mar 29, 2024

Changes in this version

+ const CompressionTypeGNUZipped

+ const CompressionTypeNone

+ const CompressionTypeXZ

+ const Darwin

+ const EnvironmentPathIdentifier

+ const KernelVersionIdentifier — darwin/amd64, linux/amd64

+ const LineEnding

+ const Linux

+ const OperatingSystemBuildIdentifier — darwin/amd64, windows/amd64

+ const OperatingSystemIdentifier — darwin/amd64, linux/amd64, windows/amd64

+ const OperatingSystemVersionIdentifier — darwin/amd64, linux/amd64, windows/amd64

+ const OperatingSystemVersionMajorIdentifier — windows/amd64

+ const OperatingSystemVersionMinorIdentifier — windows/amd64

+ const Windows

+ var ErrDirectoryNotEmpty = syscall.ENOTEMPTY — darwin/amd64, js/wasm, linux/amd64

+ var ErrDirectoryNotEmpty = syscall.ERROR_DIR_NOT_EMPTY — windows/amd64

+ var ErrNotADirectory = errors.New("not a directory")

+ var ErrNotAFile = errors.New("not a file")

+ var HTTPClient *http.Client = func() *http.Client { ... }()

+ func ActivityIndicator(stream io.Writer, description ...string) (stopIndicator func())

+ func AnySliceToTypeSlice[T any](anySlice []any) (typeSlice []T)

+ func AppendToFile(name string) (*os.File, error)

+ func BatchFileExtension() (extension string)

+ func BinaryExtension() (extension string)

+ func CanonicalizeAndEvaluateSymlinks(path string) (resolvedPath string, err error)

+ func Capture(call func()) (output []byte, err error)

+ func CaptureWithCGo(call func()) (output []byte, err error) — linux/amd64

+ func Chdir(workingDirectory string, call func() error) (err error)

+ func ChecksumForPath(path string) (digest []byte, err error)

+ func ChecksumsSHA256ForFiles(filePath string) (err error)

+ func CommandFileExtension() (extension string)

+ func CompressDirectory(srcDirectory string, archive string) (err error)

+ func CopyFile(src string, dst string) (err error)

+ func CopyFileCompressed(src string, dst string, compressionLevel int) (err error)

+ func CopyTree(sourcePath string, destinationPath string) (err error)

+ func DirExists(filePath string) error

+ func DirectoriesRecursive(directoryPath string) (directories []string, err error)

+ func DirectoryPermissionOfParent(path string) (permission fs.FileMode, err error)

+ func DownloadFile(url string, filePath string) (err error)

+ func DownloadFileWithProgress(url string, filePath string) (err error)

+ func EnforceProcessTreeLimits(limits ProcessTreeLimits)

+ func EnvOrDefault(key string, defaultValue string) (value string)

+ func EnvironmentPathList() (filePaths []string)

+ func ExtractFile(archiveFilePath string, destinationPath string) (err error)

+ func FileChange(filePath string, change func(data []byte) (changed []byte, err error)) error

+ func FileExists(filePath string) error

+ func FileOrSymlinkExists(filepath string) error

+ func FilePermissionOfParent(path string) (permission fs.FileMode, err error)

+ func FilesRecursive(path string) (files []string, err error)

+ func ForEachFile(path string, handle func(filePath string) error) error

+ func GreatestCommonDirectory(paths []string) string

+ func Info() (info map[string]string, err error) — darwin/amd64, linux/amd64, windows/amd64

+ func IsArchitectureARMWith32Bit() bool

+ func IsArchitectureARMWith64Bit() bool

+ func IsArchitectureX86With32Bit() bool

+ func IsArchitectureX86With64Bit() bool

+ func IsDarwin() bool

+ func IsEnvEnabled(key string, additionalEnabledValues ...string) bool

+ func IsLinux() bool

+ func IsWindows() bool

+ func MakeFileCopyTargets(sourceMakefilePath string, destinationMakefilePath string, ...) (err error)

+ func MkdirAll(path string) error

+ func ProgressBar(stream io.Writer, max int, description ...string) (progress *progressbar.ProgressBar)

+ func ProgressBarBytes(stream io.Writer, length int, description ...string) (progress *progressbar.ProgressBar)

+ func RemoveFileIfExists(filePath string) error

+ func RemoveFromEnvironmentPathBySearchTerm(searchTerms ...string) (newEnvironmentPath string)

+ func RemoveTemporaryDirectory(directoryPath string)

+ func ReplaceVariablesInFile(filePath string, variables map[string]string) (err error)

+ func RequireEnv(key string) (value string, err error)

+ func RewriteStaticIndexFile(filePath string) (err error)

+ func SetRLimitFiles(limit uint64, call func(limit uint64)) (err error) — linux/amd64

+ func Stat(filePath string) (os.FileInfo, error)

+ func Tar(archiveFilePath string, path string) error

+ func TarExtract(stream io.Reader, destinationPath string, compressionType CompressionType) (err error)

+ func TarExtractFile(archiveFilePath string, destinationPath string) (err error)

+ func TestCapture(t *testing.T) — linux/amd64

+ func TestCaptureRecursive(t *testing.T) — linux/amd64

+ func TestCaptureWithCGo(t *testing.T) — linux/amd64

+ func TestCaptureWithCGoWithHugeOutput(t *testing.T) — linux/amd64

+ func TestCaptureWithCGoWithPanic(t *testing.T) — linux/amd64

+ func TestCaptureWithHugeOutput(t *testing.T) — linux/amd64

+ func TestCaptureWithPanic(t *testing.T) — linux/amd64

+ func Uncompress(archive io.Reader, dstDirectory string) (err error)

+ func ValidateChecksumForPath(path string, checksumFile string) (valid bool, err error)

+ func WriteChecksumForPath(path string, checksumFile string) error

+ func ZipExtractFile(archiveFilePath string, destinationPath string) (err error)

+ type CompressionType string

+ type FilePathsByHierarchy []string

+ func (s FilePathsByHierarchy) Len() int

+ func (s FilePathsByHierarchy) Less(i, j int) bool

+ func (s FilePathsByHierarchy) Swap(i, j int)

+ type InMemoryStream struct

+ func NewInMemoryStream(reader io.ReadCloser, writer io.WriteCloser) *InMemoryStream

+ func (s *InMemoryStream) Close() error

+ func (s *InMemoryStream) Read(buffer []byte) (n int, err error)

+ func (s *InMemoryStream) Write(data []byte) (n int, err error)

+ type ProcessTreeLimits struct

+ MaxMemoryInMiB uint

+ OnMemoryLimitReached func(currentMemoryInMiB uint, maxMemoryInMiB uint)

+ WatchdogInterval time.Duration

+ type StandardStream struct

+ func (s *StandardStream) Close() error

+ func (s *StandardStream) Read(buffer []byte) (n int, err error)

+ func (s *StandardStream) Write(data []byte) (n int, err error)

+ type StaticFile struct

+ Data string

+ Directory bool

+ Hash string

+ Mime string

+ Mtime time.Time

+ Size int

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