vault

type Event struct {
	Kind EventKind `json:"kind"`
	Rel  string    `json:"rel"` // KindDocChanged 时为变更文件的相对路径
}

type EventKind int

type Node struct {
	Name     string  `json:"name"`
	Rel      string  `json:"rel"` // 相对文档根目录的路径，根节点为空串
	IsDir    bool    `json:"isDir"`
	Children []*Node `json:"children,omitempty"`
}

type RawDoc struct {
	Rel     string
	Content []byte
}

type Vault interface {
	// Root 返回消解符号链接后的绝对根路径。
	Root() string
	// Tree 返回当前的文件树快照。没有任何文档时返回一个空的根节点。
	Tree() *Node
	// Read 读取根目录内的相对路径文件。
	// 路径逃逸时返回 ErrOutsideRoot，文件不存在时返回 os.ErrNotExist，
	// 路径在根内但不是可读文档（目录、设备文件、隐藏文件，或读取时发生 I/O 错误）时返回 ErrNotReadable。
	Read(rel string) ([]byte, error)
	// RawDocs 返回全部 Markdown 文档的原始内容快照。
	RawDocs() []RawDoc
	// Watch 持续推送文件变更事件，直到 ctx 结束时关闭返回的 channel。
	Watch(ctx context.Context) <-chan Event
}