os

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

Index

• Variables
• func GetEnvAsFloat64OrFallback(key string, defaultValue float64) (float64, error)
• func GetEnvAsIntOrFallback(key string, defaultValue int) (int, error)
• func GetEnvAsStringOrFallback(key, defaultValue string) string
• func GetPidsByName(timeout time.Duration, name string) ([]int, string, error)
• func GetProcId() string
• func GetProcIdWithRand() string
• func GetValueOrFallback[T comparable](v, defaultValue T) T
• func Getwd() (string, error)
• func IsDir(path string) (bool, error)
• func IsHidden(path string) (bool, error)
• func MakeDir(name string) error
• func MakeDirAll(name string) error
• func MakeTempDirAll(name, pattern string) (string, error)
• func OpenAll(path string, flag int, perm os.FileMode) (*os.File, error)
• func OpenFile(path string, appended bool) (file *os.File, err error)
• func PathExist(path string) (bool, error)
• func ReadDirFileNames(path string, filterHiddenFile bool) ([]string, error)
• func ReadDirNames(path string, filterHiddenFile bool) ([]string, error)
• func ReadDirSubDirNames(path string, filterHiddenFile bool) ([]string, error)
• func RemoveBatch(filenames []string) error
• func RemoveWithGlob(pattern string) error
• func SameFile(fi1, fi2 string) bool
• func SymLink(oldname, newname string) error

Variables

var ShutdownSignals = []os.Signal{syscall.SIGINT, syscall.SIGTERM}

CTRL + C for SIGINT docker stop for SIGTERM

Functions

func GetEnvAsFloat64OrFallback

func GetEnvAsFloat64OrFallback(key string, defaultValue float64) (float64, error)

GetEnvAsFloat64OrFallback returns the env variable (parsed as float64) for the given key and falls back to the given defaultValue if not set

func GetEnvAsIntOrFallback

func GetEnvAsIntOrFallback(key string, defaultValue int) (int, error)

GetEnvAsIntOrFallback returns the env variable (parsed as integer) for the given key and falls back to the given defaultValue if not set

func GetEnvAsStringOrFallback

func GetEnvAsStringOrFallback(key, defaultValue string) string

GetEnvAsStringOrFallback returns the env variable for the given key and falls back to the given defaultValue if not set

func GetPidsByName

func GetPidsByName(
	timeout time.Duration,
	name string) ([]int, string, error)

func GetProcId

func GetProcId() string

func GetProcIdWithRand

func GetProcIdWithRand() string

获取进程唯一标识符

func GetValueOrFallback

func GetValueOrFallback[T comparable](v, defaultValue T) T

func Getwd

func Getwd() (string, error)

func IsDir

func IsDir(path string) (bool, error)

func IsHidden

func IsHidden(path string) (bool, error)

func MakeDir

func MakeDir(name string) error

func MakeDirAll

func MakeDirAll(name string) error

MkdirAll creates a directory named path, along with any necessary parents, and returns nil, or else returns an error. The permission(0755) bits perm (before umask) are used for all directories that MkdirAll creates. If path is already a directory, MkdirAll does nothing

func MakeTempDirAll

func MakeTempDirAll(name, pattern string) (string, error)

if name is empty, create a directory named name, or creates a new temporary directory in the directory dir pattern can be empty

func OpenAll

func OpenAll(path string, flag int, perm os.FileMode) (*os.File, error)

func OpenFile

func OpenFile(path string, appended bool) (file *os.File, err error)

func PathExist

func PathExist(path string) (bool, error)

func ReadDirFileNames

func ReadDirFileNames(path string, filterHiddenFile bool) ([]string, error)

func ReadDirNames

func ReadDirNames(path string, filterHiddenFile bool) ([]string, error)

include subdir, file and hidden file

func ReadDirSubDirNames

func ReadDirSubDirNames(path string, filterHiddenFile bool) ([]string, error)

only inlcude subdir filterHiddenFile is true, then filter hidden files from result

func RemoveBatch

func RemoveBatch(filenames []string) error

func RemoveWithGlob

func RemoveWithGlob(pattern string) error

func SameFile

func SameFile(fi1, fi2 string) bool

SameFile reports whether fi1 and fi2 describe the same file.

func SymLink

func SymLink(oldname, newname string) error

oldname and newname is full path