options

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 15, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttachOptions 

type AttachOptions struct {
	ConnectOptions `yaml:",inline"`
}

AttachOptions attach 子命令选项

func NewDefaultAttachOptions 

func NewDefaultAttachOptions() AttachOptions

NewDefaultAttachOptions 创建默认 AttachOptions

func (*AttachOptions) AddPFlags 

func (opts *AttachOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 绑定选项到命令行

type BenchOptions 

type BenchOptions struct {
	ConnectOptions `yaml:",inline"`
}

BenchOptions bench 子命令选项

func NewDefaultBenchOptions 

func NewDefaultBenchOptions() BenchOptions

NewDefaultBenchOptions 创建默认 BenchOptions

type ClientOptions 

type ClientOptions struct {
	// 服务端地址
	Server string `json:"server,omitempty" yaml:"server,omitempty"`
	// 用于认证的 Token
	Token string `json:"token,omitempty" yaml:"token,omitempty"`
	// 不登陆，使用匿名用户访问
	NoLogin bool `json:"noLogin,omitempty" yaml:"noLogin,omitempty"`
	// 始终使用新用户登录
	RenewUser bool `json:"renewUser,omitempty" yaml:"renewUser,omitempty"`
	// 是否对传输数据进行压缩
	Compress bool `json:"compress,omitempty" yaml:"compress,omitempty"`
}

ClientOptions 客户端选项

func NewDefaultClientOptions 

func NewDefaultClientOptions() ClientOptions

NewDefaultClientOptions 创建默认 ClientOptions

func (*ClientOptions) AddPFlags 

func (opts *ClientOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 绑定选项到命令行

func (*ClientOptions) NewClient 

func (opts *ClientOptions) NewClient(ctx context.Context) (clientscommon.Client, error)

NewClient 基于选项创建客户端

type ConnectOptions 

type ConnectOptions struct {
	ClientOptions `yaml:",inline"`
	// 连接的流名
	Stream string `json:"stream,omitempty" yaml:"stream,omitempty"`
}

ConnectOptions 建立连接公共选项

func NewDefaultConnectOptions 

func NewDefaultConnectOptions() ConnectOptions

NewDefaultConnectOptions 创建默认 ConnectOptions

func (*ConnectOptions) AddPFlags 

func (opts *ConnectOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 绑定选项到命令行

type ExecOptions 

type ExecOptions struct {
	ConnectOptions `yaml:",inline"`
	// 是否需要开启标准输入流
	Input bool `json:"input,omitempty" yaml:"input,omitempty"`
	// 标准输入是 TTY
	TTY bool `json:"tty,omitempty" yaml:"tty,omitempty"`
	// 是否同意所有二次确认
	Yes bool `json:"yes,omitempty" yaml:"yes,omitempty"`
}

ExecOptions exec 子命令选项

func NewDefaultExecOptions 

func NewDefaultExecOptions() ExecOptions

NewDefaultExecOptions 创建默认 ExecOptions

func (*ExecOptions) AddPFlags 

func (opts *ExecOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 绑定选项到命令行

type ExecRemoteOptions 

type ExecRemoteOptions struct {
	ClientOptions `yaml:",inline"`
	// 是否需要开启标准输入流
	Input bool `json:"input,omitempty" yaml:"input,omitempty"`
	// 标准输入是 TTY
	TTY bool `json:"tty,omitempty" yaml:"tty,omitempty"`
}

ExecRemoteOptions exec-remote 子命令选项

func NewDefaultExecRemoteOptions 

func NewDefaultExecRemoteOptions() ExecRemoteOptions

NewDefaultExecRemoteOptions 创建默认 ExecRemoteOptions

func (*ExecRemoteOptions) AddPFlags 

func (opts *ExecRemoteOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 绑定选项到命令行

type GlobalOptions 

type GlobalOptions struct {
	// 日志数量级别（ 0 / 1 / 2 ）
	Verbosity uint32 `json:"verbosity" yaml:"verbosity"`
	// proof 数据导出接口监听地址
	ProfilingAddr string `json:"profilingAddr,omitempty" yaml:"profilingAddr,omitempty"`
	// 将 CPU 性能数据导出到指定文件
	CPUProfile string `json:"cpuProfile,omitempty" yaml:"cpuProfile,omitempty"`
}

GlobalOptions 全局选项

func NewDefaultGlobalOptions 

func NewDefaultGlobalOptions() GlobalOptions

NewDefaultGlobalOptions 返回默认全局选项

func (*GlobalOptions) AddPFlags 

func (o *GlobalOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 将选项绑定到命令行参数

func (*GlobalOptions) Validate 

func (o *GlobalOptions) Validate() error

Validate 校验选项是否合法

type Options 

type Options struct {
	// 全局选项
	Global GlobalOptions `json:"global,omitempty" yaml:"global,omitempty"`

	// serve 子命令选项
	Serve ServeOptions `json:"serve,omitempty" yaml:"serve,omitempty"`

	// attach 子命令选项
	Attach AttachOptions `json:"attach,omitempty" yaml:"attach,omitempty"`
	// exec 子命令选项
	Exec ExecOptions `json:"exec,omitempty" yaml:"exec,omitempty"`
	// exec-remote 子命令选项
	ExecRemote ExecRemoteOptions `json:"execRemote,omitempty" yaml:"execRemote,omitempty"`

	// send-file 子命令选项
	SendFile SendFileOptions `json:"sendFile,omitempty" yaml:"sendFile,omitempty"`
	// receive-file 子命令选项
	ReceiveFile ReceiveFileOptions `json:"receiveFile,omitempty" yaml:"receiveFile,omitempty"`

	// bench 子命令选项
	Bench BenchOptions `json:"bench,omitempty" yaml:"bench,omitempty"`

	// stream 子命令选项
	Stream StreamOptions `json:"stream,omitempty" yaml:"stream,omitempty"`

	// version 子命令选项
	Version VersionOptions `json:"version,omitempty" yaml:"version,omitempty"`
}

Options pcrctl 运行选项

func NewDefaultOptions 

func NewDefaultOptions() Options

NewDefaultOptions 创建一个默认运行选项

type ReceiveFileOptions 

type ReceiveFileOptions struct {
	ConnectOptions `yaml:",inline"`
}

ReceiveFileOptions receive-file 子命令选项

func NewDefaultReceiveFileOptions 

func NewDefaultReceiveFileOptions() ReceiveFileOptions

NewDefaultReceiveFileOptions 创建默认 ReceiveFileOptions

func (*ReceiveFileOptions) AddPFlags 

func (opts *ReceiveFileOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 绑定选项到参数

type SendFileOptions 

type SendFileOptions struct {
	ClientOptions `yaml:",inline"`
}

SendFileOptions send-file 子命令选项

func NewDefaultSendFileOptions 

func NewDefaultSendFileOptions() SendFileOptions

NewDefaultSendFileOptions 创建默认 SendFileOptions

func (*SendFileOptions) AddPFlags 

func (opts *SendFileOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 绑定选项到参数

type ServeOptions 

type ServeOptions struct {
	ListenAddr string `json:"listenAddr,omitempty" yaml:"listenAddr,omitempty"`
	JWTIssuer  string `json:"jwtIssuer,omitempty" yaml:"jwtIssuer,omitempty"`
	JWTKey     []byte `json:"jwtKey,omitempty" yaml:"jwtKey,omitempty"`
}

ServeOptions serve 子命令选项

func NewDefaultServeOptions 

func NewDefaultServeOptions() ServeOptions

NewDefaultServeOptions 创建默认 serve 子命令选项

func (*ServeOptions) AddPFlags 

func (opts *ServeOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 绑定选项到参数

type StreamDeleteOptions 

type StreamDeleteOptions struct {
	ClientOptions `yaml:",inline"`
}

StreamDeleteOptions stream delete 子命令选项

type StreamGetOptions 

type StreamGetOptions struct {
	ClientOptions `yaml:",inline"`
}

StreamGetOptions stream get 子命令选项

type StreamListOptions 

type StreamListOptions struct {
	ClientOptions `yaml:",inline"`
}

StreamListOptions stream list 子命令选项

type StreamOptions 

type StreamOptions struct {
	// stream get 子命令选项
	Get StreamGetOptions `json:"get,omitempty" yaml:"get,omitempty"`
	// stream list 子命令选项
	List StreamListOptions `json:"list,omitempty" yaml:"list,omitempty"`
	// stream delete 子命令选项
	Delete StreamDeleteOptions `json:"delete,omitempty" yaml:"delete,omitempty"`
}

StreamOptions stream 子命令选项

func NewDefaultStreamOptions 

func NewDefaultStreamOptions() StreamOptions

NewDefaultStreamOptions 创建默认 StreamOptions

type VersionOptions 

type VersionOptions struct {
	// 输出格式
	// yaml 或 json
	OutputFormat string `json:"outputFormat,omitempty" yaml:"outputFormat,omitempty"`
}

VersionOptions version 子命令选项

func NewDefaultVersionOptions 

func NewDefaultVersionOptions() VersionOptions

NewDefaultVersionOptions 创建一个默认的 version 子命令选项

func (*VersionOptions) AddPFlags 

func (opts *VersionOptions) AddPFlags(fs *pflag.FlagSet)

AddPFlags 将选项绑定到命令行

func (*VersionOptions) Validate 

func (opts *VersionOptions) Validate() error

Validate 校验选项

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.