application

type ArchiveEntry struct {
	// Name 是归档内部使用正斜杠表示的条目路径或名称 / Name is the entry path or name inside the archive using forward slashes where applicable
	Name string
	// Size 是条目解压后的字节数 / Size is the decompressed size of the entry in bytes
	Size int64
	// Kind 是区分普通文件、虚拟文件和序列化文件的条目类别 / Kind classifies the entry as a regular, virtual, or serialized file
	Kind string
}

type ArchiveListing struct {
	// FormatID 是生成列表的归档格式标识符 / FormatID is the archive format identifier used to produce the listing
	FormatID string
	// Entries 是按名称排序的归档条目 / Entries contains archive entries sorted by name
	Entries []ArchiveEntry
	// contains filtered or unexported fields
}

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

type Artifact struct {
	// Name 是建议用于保存主要制品的文件名 / Name is the suggested filename for the primary artifact
	Name string
	// FormatID 是制品对应的稳定格式标识符 / FormatID is the stable format identifier associated with the artifact
	FormatID string
	// Representation 表示制品是原生格式还是编辑 JSON / Representation indicates whether the artifact is native data or editing JSON
	Representation Representation
	// Size 是主要制品的字节数 / Size is the primary artifact size in bytes
	Size int64
	// SHA256 是主要制品内容的 SHA-256 摘要 / SHA256 is the SHA-256 digest of the primary artifact content
	SHA256 string
	// Attachments 保存与主要制品共同生成的可选伴随文件 / Attachments contains optional companion files emitted with the primary artifact
	Attachments *ArtifactAttachmentSet
}

type ArtifactAttachment struct {
	// Suffix 是追加到主要制品名称后的受管理后缀 / Suffix is the managed suffix appended to the primary artifact name
	Suffix string
	// Name 是伴随文件的完整建议文件名 / Name is the complete suggested filename for the companion file
	Name string
	// Size 是伴随文件的字节数 / Size is the companion file size in bytes
	Size int64
	// SHA256 是伴随文件内容的 SHA-256 摘要 / SHA256 is the SHA-256 digest of the companion file content
	SHA256 string
	// Data 保存在短生命周期工作区中生成的伴随文件内容 / Data retains companion content produced inside the short-lived workspace
	Data []byte
}

type ArtifactAttachmentSet struct {
	// Files 是按受管理后缀顺序排列的伴随文件 / Files contains companion files in managed-suffix order
	Files []ArtifactAttachment
}

type BundleFile struct {
	// Suffix 为空时表示主要文件，否则必须是受管理伴随文件后缀 / Suffix identifies the primary file when empty or a managed companion suffix otherwise
	Suffix string
	// Reader 提供待安装文件的内容 / Reader supplies the content of the file to install
	Reader io.Reader
	// ExpectedSize 是提交前可选校验的精确字节数 / ExpectedSize is an optional exact byte size verified before commit
	ExpectedSize *int64
	// ExpectedSHA256 是提交前可选校验的十六进制 SHA-256 摘要 / ExpectedSHA256 is an optional hexadecimal SHA-256 digest verified before commit
	ExpectedSHA256 string
}

type BundleFileMetadata struct {
	// Suffix 标识主要文件或受管理伴随文件 / Suffix identifies the primary file or managed companion file
	Suffix string
	// Size 是已安装文件的精确字节数 / Size is the exact installed file size in bytes
	Size int64
	// SHA256 是已安装文件内容的十六进制 SHA-256 摘要 / SHA256 is the hexadecimal SHA-256 digest of the installed file content
	SHA256 string
}

type Capability struct {
	// Detect 表示是否支持格式检测 / Detect reports whether format detection is supported
	Detect bool
	// Convert 表示是否支持原生格式与编辑 JSON 互转 / Convert reports whether native and editing JSON conversion is supported
	Convert bool
	// Validate 表示是否支持完整格式校验 / Validate reports whether full format validation is supported
	Validate bool
	// Archive 表示是否支持归档列表和条目提取 / Archive reports whether archive listing and entry extraction are supported
	Archive bool
}

type ConvertRequest struct {
	// Source 是需要转换的输入制品 / Source is the input artifact to convert
	Source Source
	// FormatID 是可选的显式格式标识符，空值触发自动检测 / FormatID is an optional explicit format identifier with an empty value requesting detection
	FormatID string
	// To 是转换目标表示形式 / To is the target representation of the conversion
	To Representation
}

type Detection struct {
	// FormatID 是注册表使用的稳定格式标识符 / FormatID is the stable format identifier used by the registry
	FormatID string
	// Game 是检测到的游戏或工具名称 / Game is the detected game or tool name
	Game string
	// FileType 是检测到的规范文件类型 / FileType is the detected canonical file type
	FileType string
	// Representation 表示文件是原生格式还是编辑 JSON / Representation indicates whether the file is native data or editing JSON
	Representation Representation
	// StorageFormat 描述底层存储编码方式 / StorageFormat describes the underlying storage encoding
	StorageFormat string
	// Signature 是格式携带的文件签名 / Signature is the file signature carried by the format
	Signature string
	// Version 是检测到的精确格式版本 / Version is the exact detected format version
	Version int32
	// Name 是不包含目录的源文件名 / Name is the source filename without directory components
	Name string
	// Size 是源文件的字节数 / Size is the source file size in bytes
	Size int64
}

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

type EngineOptions struct {
	// Registry 是引擎用于查找格式的注册表，空值使用默认注册表 / Registry is the format registry used by the engine with nil selecting the default registry
	Registry *Registry
	// MaxInputBytes 是单次操作允许读取的最大输入字节数 / MaxInputBytes is the maximum number of input bytes read by one operation
	MaxInputBytes int64
	// MaxOutputBytes 是单次操作允许生成的最大输出字节数 / MaxOutputBytes is the maximum number of output bytes produced by one operation
	MaxOutputBytes int64
	// MaxArchiveListingBytes 是列出归档前允许物化的最大输入字节数 / MaxArchiveListingBytes is the maximum number of input bytes materialized before listing an archive
	MaxArchiveListingBytes int64
	// MaxArchiveEntries 是单个归档列表允许返回的最大条目数 / MaxArchiveEntries is the maximum number of entries returned by one archive listing
	MaxArchiveEntries int
}

type ErrorCode string

type Format struct {
	// ID 是由游戏名和文件类型组成的稳定格式标识符 / ID is the stable format identifier composed from the game and file type
	ID string
	// Game 是拥有该格式的游戏或工具名称 / Game is the name of the game or tool that owns the format
	Game string
	// FileType 是服务层使用的规范文件类型名称 / FileType is the canonical file type name used by the service layer
	FileType string
	// NativeSuffixes 是该格式接受的原生文件后缀 / NativeSuffixes contains the native file suffixes accepted for the format
	NativeSuffixes []string
	// DefaultName 是缺少可用输入名称时采用的原生文件名 / DefaultName is the native filename used when no suitable input name is available
	DefaultName string
	// Capability 描述该格式支持的应用操作 / Capability describes the application operations supported by the format
	Capability Capability
	// SchemaVersion 是已发布编辑模式的版本 / SchemaVersion is the version of the published editing schema
	SchemaVersion string
	// SchemaID 是已发布编辑模式的规范标识符 / SchemaID is the canonical identifier of the published editing schema
	SchemaID string
	// SchemaSHA256 是已发布编辑模式的 SHA-256 摘要 / SchemaSHA256 is the SHA-256 digest of the published editing schema
	SchemaSHA256 string
	// GuideVersion 是已发布格式指南的版本 / GuideVersion is the version of the published format guide
	GuideVersion string
	// GuideID 是已发布格式指南的规范标识符 / GuideID is the canonical identifier of the published format guide
	GuideID string
	// GuideSHA256 是已发布格式指南的 SHA-256 摘要 / GuideSHA256 is the SHA-256 digest of the published format guide
	GuideSHA256 string
	// GuideVerification 描述已发布指南对整个文件格式的认证等级 / GuideVerification describes the whole-file verification level of the published guide
	GuideVerification string
	// contains filtered or unexported fields
}

type GuideDocument struct {
	// FormatID 是指南对应的稳定格式标识符 / FormatID is the stable format identifier associated with the guide
	FormatID string
	// Version 是指南文档版本 / Version is the guide document version
	Version string
	// ID 是指南文档的规范标识符 / ID is the canonical identifier of the guide document
	ID string
	// MediaType 是指南文档的媒体类型 / MediaType is the media type of the guide document
	MediaType string
	// SHA256 是指南 JSON 的 SHA-256 摘要 / SHA256 is the SHA-256 digest of the guide JSON
	SHA256 string
	// SchemaID 是指南引用的编辑模式标识符 / SchemaID is the editing schema identifier referenced by the guide
	SchemaID string
	// FormatVerification 描述整个文件格式的认证等级 / FormatVerification describes the verification level of the whole file format
	FormatVerification string
	// JSON 保存可直接交给调用方的指南 JSON / JSON contains the guide JSON ready for callers to consume
	JSON []byte
}

type OpError struct {
	// Op 是发生错误的操作名称 / Op is the name of the operation that failed
	Op string
	// Code 是供调用方判断的稳定错误代码 / Code is the stable error code exposed to callers
	Code ErrorCode
	// Err 是原始底层错误 / Err is the original underlying error
	Err error
}

type ReadSeekCloser interface {
	io.Reader
	io.Seeker
	io.Closer
}

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

type Representation string

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

type SchemaDocument struct {
	// FormatID 是模式对应的稳定格式标识符 / FormatID is the stable format identifier associated with the schema
	FormatID string
	// Representation 是该模式描述的应用层表示形式 / Representation is the application representation described by the schema
	Representation Representation
	// Version 是模式文档版本 / Version is the schema document version
	Version string
	// ID 是模式文档的规范标识符 / ID is the canonical identifier of the schema document
	ID string
	// Dialect 是模式使用的 JSON Schema 方言 / Dialect is the JSON Schema dialect used by the document
	Dialect string
	// MediaType 是模式文档的媒体类型 / MediaType is the media type of the schema document
	MediaType string
	// SHA256 是模式 JSON 的 SHA-256 摘要 / SHA256 is the SHA-256 digest of the schema JSON
	SHA256 string
	// NativeSuffixes 是该格式支持的原生文件后缀 / NativeSuffixes contains the native file suffixes supported by the format
	NativeSuffixes []string
	// JSON 保存可直接用于校验或代码生成的模式 JSON / JSON contains schema JSON ready for validation or code generation
	JSON []byte
}

type Source interface {
	// Name 返回适合物化输入时使用的文件名
	// Name returns the filename to use when materializing the source
	Name() string
	// Size 返回源内容的精确字节数
	// Size returns the exact source content size in bytes
	Size() int64
	// Open 打开受上下文约束的独立可定位读取器
	// Open opens an independent seekable reader governed by a context
	Open(context.Context) (ReadSeekCloser, error)
}

type SourceAttachment struct {
	// Suffix 是追加到主要源文件名后的受管理后缀 / Suffix is the managed suffix appended to the primary source name
	Suffix string
	// Source 提供伴随文件的内容和元数据 / Source provides the companion file content and metadata
	Source Source
}