oss

README

oss

操作系统相关函数。

goos

IsDarwin

是否是 Darwin 系统

IsLinux

是否是 Linux 系统

IsWindows

是否是 Windows 系统

os

Open

打开文件

Show

在目录中显示

path

Abs

返回路径的绝对表示，~符号表示用户根目录。

Exist

文件或目录是否存在。

IsDir

路径是否是目录。

Documentation

Overview

Package oss 操作系统相关.

Index

• Constants
• Variables
• func Abs(path string) (string, error)
• func AppendFile(filename string) (*os.File, error)
• func Cancel(cancel context.CancelFunc)
• func CancelContext(ctx context.Context) (context.Context, context.CancelFunc)
• func CancelFunc(cancel context.CancelFunc) func() error
• func Exist(path string) bool
• func IsDarwin() bool
• func IsDir(path string) bool
• func IsLinux() bool
• func IsRelease() bool
• func IsWindows() bool
• func Open(file string) error
• func Remove(path string, depth int) error
• func Show(file string) error
• type ProcInfo
  • func NewProcInfo() *ProcInfo
  • func (p *ProcInfo) String() string

Examples

• Abs
• AppendFile
• Cancel
• CancelContext
• IsDarwin
• IsLinux
• IsRelease
• IsWindows

Constants

const (
	DefaultFileMode   os.FileMode = 0o664
	DefaultDirFileMod os.FileMode = 0o771
)

Variables

var (
	// Version 版本号.
	Version = ""
	// BuildTime 编译时间.
	BuildTime = ""
)

nolint: gochecknoglobals

var ErrNotDefined = errors.New("OS is not defined")

ErrNotDefined 系统不支持.

Functions

func Abs

func Abs(path string) (string, error)

Abs 返回路径的绝对表示，~符号表示用户根目录.

Example

package main

import (
	"fmt"
	"os"
	"path/filepath"

	"github.com/samber/lo"
	"github.com/xuender/kit/oss"
)

func main() {
	home, _ := os.UserHomeDir()
	fmt.Println(lo.Must1(oss.Abs("~/file")) == filepath.Join(home, "file"))

}

Output:

true

func AppendFile

func AppendFile(filename string) (*os.File, error)

AppendFile appends the given file.

Example

ExampleAppendFile is an example function.

package main

import (
	"fmt"
	"os"
	"path/filepath"

	"github.com/xuender/kit/oss"
)

func main() {
	file, err := oss.AppendFile(filepath.Join(os.TempDir(), "go-cli", "create.txt"))
	fmt.Println(err)
	fmt.Println(file.WriteString("123"))
	file.Close()

	file, err = oss.AppendFile(filepath.Join(os.TempDir(), "go-cli", "create.txt"))
	fmt.Println(err)

	_, _ = file.WriteString("aaaa")
	file.Close()

	data, _ := os.ReadFile(file.Name())
	fmt.Println(string(data))
	os.Remove(file.Name())

}

Output:

<nil>
3 <nil>
<nil>
123aaaa

func Cancel

func Cancel(cancel context.CancelFunc)

Example

package main

import (
	"fmt"
	"os"
	"syscall"
	"time"

	"github.com/xuender/kit/oss"
)

func main() {
	cancel := func() {
		fmt.Println("cancel")
	}

	go oss.Cancel(cancel)

	time.Sleep(time.Millisecond * 5)

	_ = syscall.Kill(os.Getpid(), syscall.SIGINT)

	time.Sleep(time.Millisecond * 5)

}

Output:

cancel

func CancelContext

func CancelContext(ctx context.Context) (context.Context, context.CancelFunc)

Example

package main

import (
	"context"
	"fmt"
	"os"
	"syscall"
	"time"

	"github.com/xuender/kit/oss"
)

func main() {
	ctx, _ := oss.CancelContext(context.Background())

	go func() {
		<-ctx.Done()

		fmt.Println("cancel")
	}()

	time.Sleep(time.Millisecond * 5)

	_ = syscall.Kill(os.Getpid(), syscall.SIGINT)

	time.Sleep(time.Millisecond * 5)

}

Output:

cancel

func CancelFunc

func CancelFunc(cancel context.CancelFunc) func() error

func Exist

func Exist(path string) bool

Exist 文件或目录是否存在.

func IsDarwin

func IsDarwin() bool

IsDarwin 是否是 Darwin 系统.

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/oss"
)

func main() {
	fmt.Println(oss.IsDarwin())

}

Output:

false

func IsDir

func IsDir(path string) bool

IsDir 路径是否是目录.

func IsLinux

func IsLinux() bool

IsLinux 是否是 Linux 系统.

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/oss"
)

func main() {
	fmt.Println(oss.IsLinux())

}

Output:

true

func IsRelease

func IsRelease() bool

IsRelease 是否是发布模式.

Example

ExampleIsRelease 是否是发布模式例子.

package main

import (
	"fmt"

	"github.com/xuender/kit/oss"
)

func main() {
	fmt.Println(oss.IsRelease())
	oss.Version = "1.0.1"
	fmt.Println(oss.IsRelease())

}

Output:

false
true

func IsWindows

func IsWindows() bool

IsWindows 是否是 Windows 系统.

Example

package main

import (
	"fmt"

	"github.com/xuender/kit/oss"
)

func main() {
	fmt.Println(oss.IsWindows())

}

Output:

false

func Open

func Open(file string) error

Open 打开文件.

func Remove

func Remove(path string, depth int) error

Remove 文件或目录，如果父目录为空则删除.

func Show

func Show(file string) error

Show 在目录中显示.

Types

type ProcInfo

type ProcInfo struct {
	Name      string        `json:"name"`
	Dir       string        `json:"dir"`
	Pid       int           `json:"pid"`
	Version   string        `json:"version"`
	BuildTime string        `json:"buildTime"`
	StartTime time.Time     `json:"startTime"`
	RunTime   time.Duration `json:"runTime"`
}

func NewProcInfo

func NewProcInfo() *ProcInfo

func (*ProcInfo) String

func (p *ProcInfo) String() string