app

type App struct {
	// 构建新服务的方法
	NewServer func() (*server.Server, error)

	// 重启之前需要做的操作
	//
	// 可以为空。如果返回值不为 nil，将中止当前操作，但不影响旧服务。
	Before func() error

	// 每次关闭服务操作的等待时间
	ShutdownTimeout time.Duration
	// contains filtered or unexported fields
}

type CLIOf[T any] struct {
	Name    string // 程序名称
	Version string // 程序版本

	// 在运行服务之前对 [server.Server] 的额外操作
	//
	// user 为用户自定义的数据结构；
	// action 为 -a 命令行指定的参数；
	Init func(s *server.Server, user *T, action string) error

	// 以服务运行的指令
	ServeActions []string

	// 命令行输出信息的通道
	//
	// 默认为 [os.Stdout]。
	Out io.Writer

	// 配置文件所在的目录
	//
	// 这也将影响后续 [server.Options.Config] 变量，如果为空，则会采用 [server.DefaultConfigDir]。
	//
	// 有以下几种前缀用于指定不同的保存目录：
	//  - ~ 表示系统提供的配置文件目录，比如 Linux 的 XDG_CONFIG、Window 的 AppData 等；
	//  - @ 表示当前程序的主目录；
	//  - ^ 表示绝对路径；
	//  - # 表示工作路径；
	//  - 其它则是直接采用 [config.Dir] 初始化。
	// 如果为空则采用 [server.DefaultConfigDir] 中指定的值。
	//
	// NOTE: 具体说明可参考 [config.BuildDir] 的 dir 参数。
	ConfigDir string

	// 配置文件的文件名
	//
	// 相对于 ConfigDir 的文件名。如果为空，表示不采用配置文件，
	// 由一个空的 [server.Options] 初始化对象，具体可以查看 [NewServerOf] 的实现。
	//
	// 需要保证序列化方法已经由 [RegisterFileSerializer] 注册；
	ConfigFilename string

	// 本地化的相关设置
	//
	// 若为空，则以 NewPrinter(locales.Locales, "*.yml") 进行初始化。
	//
	// NOTE: 此设置仅影响命令行的本地化(panic 信息不支持本地化)，[server.Server] 的本地化由其自身管理。
	Printer *localeutil.Printer

	// 每次关闭服务操作的等待时间
	ShutdownTimeout time.Duration
	// contains filtered or unexported fields
}

type CacheBuilder func(dsn string) (cache.Driver, error)

type ConfigSanitizer interface {
	SanitizeConfig() *errs.FieldError
}

type LogsWriterBuilder func(args []string) (logs.Writer, func() error, error)

type MarshalFileFunc = config.MarshalFunc

type Problem struct {
	// 指定生成 Problem 对象的方法
	//
	// 这些名称由 [RegisterProblemBuilder] 注册。当前可用的值有：
	//  - rfc7807
	Builder string `json:"builder,omitempty" xml:"builder,omitempty" yaml:"builder,omitempty"`

	// 指定代码代码的 ID 前缀
	IDPrefix string `json:"idPrefix,omitempty" xml:"idPrefix,omitempty" yaml:"idPrefix,omitempty"`
}

type RestartServer interface {
	// Restart 重启服务
	//
	// 中止旧的 [server.Server]，再启动一个新的 [server.Server] 对象
	Restart()
}

type UniqueGeneratorBuilder func() server.UniqueGenerator

type UnmarshalFileFunc = config.UnmarshalFunc