cmd

README

cmd

自用库

Documentation

Index

• func Fields(src string) (out []string)
• func Rotate(options LoggerOptions) io.WriteCloser
• func Terminate(pid int, done <-chan struct{})
• func WrapClose(closers ...io.Closer) func()
• type Cmd
  • func CommandLine(commandLine string) *Cmd
  • func New(name string, args ...string) *Cmd
  • func Shell(command string) *Cmd
  • func (c *Cmd) LineRead(lineRd func(flag, line string), transformers ...func(io.Reader) io.Reader) *Cmd
  • func (c *Cmd) Logger(options LoggerOptions) *Cmd
  • func (c *Cmd) LoggerWriter(w io.WriteCloser) *Cmd
  • func (c *Cmd) PidFile(pidfile string) *Cmd
  • func (c *Cmd) PostStart(task func(c *Cmd), parallel ...bool) *Cmd
  • func (c *Cmd) PreExit(task func(c *Cmd), parallel ...bool) *Cmd
  • func (c *Cmd) Run() (state *StartState)
  • func (c *Cmd) RunWithContext(ctx context.Context) (state *StartState)
  • func (c *Cmd) Standard() *Cmd
  • func (c *Cmd) Stderr(w io.WriteCloser) *Cmd
  • func (c *Cmd) Stdout(w io.WriteCloser) *Cmd
  • func (c *Cmd) String() string
  • func (c *Cmd) With(options ...Option) *Cmd
• type FOption
  • func (f FOption) Apply(cmd *exec.Cmd) error
• type FOptionEx
  • func (f FOptionEx) Apply(cmd *exec.Cmd) error
• type FileSize
  • func ParseSize(s string) (FileSize, error)
  • func (s FileSize) MarshalJSON() ([]byte, error)
  • func (s FileSize) MarshalYAML() (any, error)
  • func (s *FileSize) SetString(in string) error
  • func (s FileSize) String() string
  • func (s FileSize) ToB() string
  • func (s FileSize) ToIB() string
  • func (s *FileSize) UnmarshalJSON(data []byte) error
  • func (s *FileSize) UnmarshalYAML(unmarshal func(any) error) error
• type LoggerOptions
• type Option
  • func Envs(envs []string) Option
  • func User(uid, pid uint32) Option
  • func WorkDir(workDir string) Option
• type Options
  • func (options Options) Apply(cmd *exec.Cmd)
• type Pid
  • func (f Pid) DelPid()
  • func (f Pid) ReadPid() (pid int)
  • func (f *Pid) SetPid(path string)
  • func (f Pid) WritePid(pid int) Pid
• type Runner
  • func (p *Runner) Append(task func(), parallel ...bool)
  • func (p *Runner) Parallel(run ...func())
  • func (p *Runner) Run()
• type StartState
  • func (s *StartState) Cancel()
  • func (s *StartState) Done() <-chan struct{}
  • func (s *StartState) Wait() error
• type Status
• type Task

Functions

func Fields

func Fields(src string) (out []string)

func Rotate

func Rotate(options LoggerOptions) io.WriteCloser

func Terminate

func Terminate(pid int, done <-chan struct{})

func WrapClose

func WrapClose(closers ...io.Closer) func()

Types

type Cmd

type Cmd struct {
	// contains filtered or unexported fields
}

func CommandLine

func CommandLine(commandLine string) *Cmd

解析单行命令

func New

func New(name string, args ...string) *Cmd

func Shell

func Shell(command string) *Cmd

执行脚本，在windows使用`cmd /c`, unix使用`bash/sh -c`(优先bash)

func (*Cmd) LineRead

func (c *Cmd) LineRead(lineRd func(flag, line string), transformers ...func(io.Reader) io.Reader) *Cmd

func (*Cmd) Logger

func (c *Cmd) Logger(options LoggerOptions) *Cmd

func (*Cmd) LoggerWriter

func (c *Cmd) LoggerWriter(w io.WriteCloser) *Cmd

func (*Cmd) PidFile

func (c *Cmd) PidFile(pidfile string) *Cmd

func (*Cmd) PostStart

func (c *Cmd) PostStart(task func(c *Cmd), parallel ...bool) *Cmd

func (*Cmd) PreExit

func (c *Cmd) PreExit(task func(c *Cmd), parallel ...bool) *Cmd

func (*Cmd) Run

func (c *Cmd) Run() (state *StartState)

func (*Cmd) RunWithContext

func (c *Cmd) RunWithContext(ctx context.Context) (state *StartState)

启动进程

func (*Cmd) Standard

func (c *Cmd) Standard() *Cmd

func (*Cmd) Stderr

func (c *Cmd) Stderr(w io.WriteCloser) *Cmd

func (*Cmd) Stdout

func (c *Cmd) Stdout(w io.WriteCloser) *Cmd

func (*Cmd) String

func (c *Cmd) String() string

进程描述

func (*Cmd) With

func (c *Cmd) With(options ...Option) *Cmd

add options

type FOption

type FOption func(cmd *exec.Cmd)

func (FOption) Apply

func (f FOption) Apply(cmd *exec.Cmd) error

type FOptionEx

type FOptionEx func(cmd *exec.Cmd) error

func (FOptionEx) Apply

func (f FOptionEx) Apply(cmd *exec.Cmd) error

type FileSize

type FileSize float64

func ParseSize

func ParseSize(s string) (FileSize, error)

mib, mb

func (FileSize) MarshalJSON

func (s FileSize) MarshalJSON() ([]byte, error)

func (FileSize) MarshalYAML

func (s FileSize) MarshalYAML() (any, error)

func (*FileSize) SetString

func (s *FileSize) SetString(in string) error

func (FileSize) String

func (s FileSize) String() string

func (FileSize) ToB

func (s FileSize) ToB() string

func (FileSize) ToIB

func (s FileSize) ToIB() string

func (*FileSize) UnmarshalJSON

func (s *FileSize) UnmarshalJSON(data []byte) error

func (*FileSize) UnmarshalYAML

func (s *FileSize) UnmarshalYAML(unmarshal func(any) error) error

type LoggerOptions

type LoggerOptions struct {
	Std     bool     `json:"std"`
	Path    string   `json:"path"`
	MaxSize FileSize `json:"max_size" yaml:"max_size"` //默认1M，最大100M
	Keep    int      `json:"keep"`                     //0, 不保留, -1, 保留所有
}

type Option

type Option interface{ Apply(cmd *exec.Cmd) error }

func Envs

func Envs(envs []string) Option

func User

func User(uid, pid uint32) Option

func WorkDir

func WorkDir(workDir string) Option

type Options

type Options []Option

func (Options) Apply

func (options Options) Apply(cmd *exec.Cmd)

type Pid

type Pid string

func (Pid) DelPid

func (f Pid) DelPid()

func (Pid) ReadPid

func (f Pid) ReadPid() (pid int)

func (*Pid) SetPid

func (f *Pid) SetPid(path string)

func (Pid) WritePid

func (f Pid) WritePid(pid int) Pid

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

顺序执行

func (*Runner) Append

func (p *Runner) Append(task func(), parallel ...bool)

func (*Runner) Parallel

func (p *Runner) Parallel(run ...func())

func (*Runner) Run

func (p *Runner) Run()

type StartState

type StartState struct {
	PID    int
	Err    error
	Status Status
	// contains filtered or unexported fields
}

func (*StartState) Cancel

func (s *StartState) Cancel()

func (*StartState) Done

func (s *StartState) Done() <-chan struct{}

func (*StartState) Wait

func (s *StartState) Wait() error

type Status

type Status string

const (
	StatusStarting Status = "starting"
	StatusStarted  Status = "started"
	StatusStopping Status = "stopping"
	StatusStopped  Status = "stopped"
)

type Task

type Task struct {
	Parallel bool
	Run      func()
}