mdx

package module

Go to main page

Versions in this module

v0

v0.1.15

Apr 24, 2026

Changes in this version

+ type IndexBuildLeaseStore interface

+ AcquireIndexBuildLease func(dictionaryName string, ttl time.Duration) (release func() error, acquired bool, err error)

type IndexSyncConfig

+ RebuildLeasePollPeriod time.Duration

+ RebuildLeaseTTL time.Duration

type IndexSyncOption

+ func WithRebuildLeasePollPeriod(period time.Duration) IndexSyncOption

+ func WithRebuildLeaseTTL(ttl time.Duration) IndexSyncOption

type RedisIndexStore

+ func (s *RedisIndexStore) AcquireIndexBuildLease(dictionaryName string, ttl time.Duration) (func() error, bool, error)

v0.1.14

Apr 24, 2026

v0.1.13

Apr 24, 2026

v0.1.12

Apr 23, 2026

Changes in this version

+ type EnsureIndexResult struct

+ DictionaryName string

+ Manifest IndexManifest

+ Rebuilt bool

+ Reused bool

+ func EnsureDictionaryIndex(dictPath string, store ManagedIndexStore, opts ...IndexSyncOption) (*EnsureIndexResult, error)

+ type FileStatFingerprinter struct

+ func (FileStatFingerprinter) Fingerprint(path string) (string, error)

+ type Fingerprinter interface

+ Fingerprint func(path string) (string, error)

+ func NewFileStatFingerprinter() Fingerprinter

+ type FingerprinterFunc func(path string) (string, error)

+ func (fn FingerprinterFunc) Fingerprint(path string) (string, error)

+ type IndexManifest struct

+ BuiltAt time.Time

+ DictionaryName string

+ ExpiresAt *time.Time

+ Fingerprint string

+ SchemaVersion string

+ SourcePath string

+ func BuildIndexManifest(dictPath string, dictName string, opts ...IndexSyncOption) (IndexManifest, error)

+ type IndexSyncConfig struct

+ Fingerprinter Fingerprinter

+ ForceRebuild bool

+ MissingSourceTTL time.Duration

+ Now func() time.Time

+ ReuseIfUnchanged bool

+ SchemaVersion string

+ func DefaultIndexSyncConfig() IndexSyncConfig

+ func ResolveIndexSyncConfig(opts ...IndexSyncOption) IndexSyncConfig

+ type IndexSyncOption func(*IndexSyncConfig)

+ func WithClock(now func() time.Time) IndexSyncOption

+ func WithFingerprinter(fp Fingerprinter) IndexSyncOption

+ func WithForceRebuild() IndexSyncOption

+ func WithMissingSourceTTL(ttl time.Duration) IndexSyncOption

+ func WithReuseIfUnchanged(enabled bool) IndexSyncOption

+ func WithSchemaVersion(version string) IndexSyncOption

+ type ManagedIndexStore interface

+ DeleteDictionary func(dictionaryName string) error

+ LoadManifest func(dictionaryName string) (IndexManifest, error)

+ SaveManifest func(manifest IndexManifest) error

type Mdict

+ func (mdict *Mdict) PrepareForExternalIndex() error

type MemoryIndexStore

+ func (s *MemoryIndexStore) DeleteDictionary(dictionaryName string) error

+ func (s *MemoryIndexStore) LoadManifest(dictionaryName string) (IndexManifest, error)

+ func (s *MemoryIndexStore) SaveManifest(manifest IndexManifest) error

type RedisIndexStore

+ func (s *RedisIndexStore) DeleteDictionary(dictionaryName string) error

+ func (s *RedisIndexStore) LoadManifest(dictionaryName string) (IndexManifest, error)

+ func (s *RedisIndexStore) SaveManifest(manifest IndexManifest) error

v0.1.11

Apr 22, 2026

v0.1.10

Apr 22, 2026

Changes in this version

+ func ConfigureDictionaryPairAssets(spec DictionarySpec, mdxDict *Mdict, mddDicts ...*Mdict)

+ func LookupAndRewriteHTMLWithEntryBase(dict *Mdict, word, assetBasePath, entryBasePath string) ([]byte, error)

+ func NewAssetHandlerWithOptions(mdd *Mdict, opts AssetHandlerOptions) http.Handler

+ func RewriteEntryAudioLinks(content []byte, assetBasePath string) []byte

+ func RewriteEntryInternalLinks(content []byte) []byte

+ func RewriteEntryLookupLinks(content []byte, entryBasePath string) []byte

+ type AssetHandlerOptions struct

+ CacheControl string

+ EnableETag bool

+ EnableLastModified bool

+ type AssetResolver struct

+ func NewAssetResolver(mdd *Mdict, opts ...AssetResolverOption) *AssetResolver

+ func (r *AssetResolver) Open(ref string) (fs.File, error)

+ func (r *AssetResolver) Read(ref string) ([]byte, error)

+ type AssetResolverOption func(*AssetResolver)

+ func WithAssetMdicts(dicts ...*Mdict) AssetResolverOption

+ func WithAssetSidecarDir(dir string) AssetResolverOption

+ func WithAssetSidecarFS(fsys fs.FS) AssetResolverOption

+ func WithAssetSource(source AssetSource) AssetResolverOption

+ type AssetSource interface

+ ReadAsset func(ref string) ([]byte, error)

type DictionarySpec

+ MDDPaths []string

type Mdict

+ func (mdict *Mdict) AssetResolver() *AssetResolver

+ func (mdict *Mdict) SetAssetResolver(resolver *AssetResolver)

v0.1.9

Apr 22, 2026

v0.1.8

Apr 22, 2026

Changes in this version

type Mdict

+ func (mdict *Mdict) FindComparableEntry(word string) (*MDictKeywordEntry, bool)

+ func (mdict *Mdict) FindExactEntry(word string) (*MDictKeywordEntry, bool)

+ func (mdict *Mdict) ResolveEntry(entry *MDictKeywordEntry) ([]byte, error)

v0.1.7

Apr 22, 2026

v0.1.6

Apr 22, 2026

v0.1.5

Apr 22, 2026

Changes in this version

+ const EncodingBig5

+ const EncodingGb18030

+ const EncodingGb2312

+ const EncodingGbk

+ const EncodingUtf16

+ const EncodingUtf8

+ const EncryptKeyInfoEnc

+ const EncryptNoEnc

+ const EncryptRecordEnc

+ const MdictTypeMdd

+ const MdictTypeMdx

+ const NumfmtBe4bytesi

+ const NumfmtBe8bytesq

+ var ErrIndexMiss = errors.New("index entry not found")

+ var ErrWordNotFound = errors.New("word not found")

+ func AssetLookupCandidates(ref string) []string

+ func AssetURL(basePath, ref string) string

+ func BuildRangeTree(list []*MdictRecordBlockInfoListItem, root *RecordBlockRangeTreeNode)

+ func ExtractResourceRefs(content []byte) []string

+ func IsResourceRef(ref string) bool

+ func LookupAndRewriteHTML(dict *Mdict, word, assetBasePath string) ([]byte, error)

+ func NewAssetHandler(mdd *Mdict) http.Handler

+ func NormalizeMDDKey(name string) string

+ func RewriteEntryResourceURLs(content []byte, assetBasePath string) []byte

+ type Dictionary struct

+ Compact string

+ Compat string

+ CreationDate string

+ DataSourceFormat string

+ Description string

+ Encoding string

+ Encrypted string

+ Format string

+ GeneratedByEngineVersion string

+ IsUTF16 string

+ KeyCaseSensitive string

+ Left2Right string

+ RegisterBy string

+ RequiredEngineVersion string

+ StripKey string

+ StyleSheet string

+ Text string

+ Title string

+ XMLName xml.Name

+ type DictionaryInfo struct

+ CreationDate string

+ Description string

+ EntryCount int64

+ GeneratedByEngineVersion string

+ IsMDD bool

+ IsRecordEncrypted bool

+ IsUTF16 bool

+ Name string

+ Title string

+ Version string

+ type DictionaryRegistry struct

+ func NewDictionaryRegistry() *DictionaryRegistry

+ func (r *DictionaryRegistry) LibrarySearch(query string, limit int) ([]LibrarySearchHit, error)

+ func (r *DictionaryRegistry) List() []DictionarySpec

+ func (r *DictionaryRegistry) LoadDirectory(root string) error

+ func (r *DictionaryRegistry) LoadSpecs(specs []DictionarySpec)

+ func (r *DictionaryRegistry) OpenDictionary(id string) (*Mdict, *Mdict, error)

+ type DictionarySpec struct

+ ID string

+ MDDPath string

+ MDXPath string

+ Name string

+ func ScanDirectory(root string) ([]DictionarySpec, error)

+ type FuzzyIndexStore interface

+ Put func(info DictionaryInfo, entries []IndexEntry) error

+ Search func(dictionaryName, query string, limit int) ([]SearchHit, error)

+ type IndexEntry struct

+ IsResource bool

+ KeyBlockIdx int64

+ Keyword string

+ NormalizedKeyword string

+ RecordEndOffset int64

+ RecordStartOffset int64

+ type IndexStore interface

+ GetExact func(dictionaryName, keyword string) (IndexEntry, error)

+ PrefixSearch func(dictionaryName, prefix string, limit int) ([]IndexEntry, error)

+ Put func(info DictionaryInfo, entries []IndexEntry) error

+ type LibrarySearchHit struct

+ DictID string

+ DictName string

+ Hit SearchHit

+ type MDictKeywordEntry struct

+ KeyBlockIdx int64

+ KeyWord string

+ RecordEndOffset int64

+ RecordStartOffset int64

+ type MDictKeywordIndex struct

+ KeywordEntry MDictKeywordEntry

+ RecordBlock MDictKeywordIndexRecordBlock

+ type MDictKeywordIndexRecordBlock struct

+ CompressSize int64

+ DataStartOffset int64

+ DeCompressSize int64

+ KeyWordPartDataEndOffset int64

+ KeyWordPartStartOffset int64

+ type Mdict struct

+ func New(filename string) (*Mdict, error)

+ func (mdict *Mdict) BuildIndex() error

+ func (mdict *Mdict) CreationDate() string

+ func (mdict *Mdict) Description() string

+ func (mdict *Mdict) DictionaryInfo() DictionaryInfo

+ func (mdict *Mdict) Digest() string

+ func (mdict *Mdict) ExportEntries() ([]IndexEntry, error)

+ func (mdict *Mdict) ExportIndex() ([]IndexEntry, error)

+ func (mdict *Mdict) ExportResources() ([]IndexEntry, error)

+ func (mdict *Mdict) GeneratedByEngineVersion() string

+ func (mdict *Mdict) GetKeyWordEntries() ([]*MDictKeywordEntry, error)

+ func (mdict *Mdict) GetKeyWordEntriesSize() int64

+ func (mdict *Mdict) IsMDD() bool

+ func (mdict *Mdict) IsRecordEncrypted() bool

+ func (mdict *Mdict) IsUTF16() bool

+ func (mdict *Mdict) KeywordEntryToIndex(item *MDictKeywordEntry) (*MDictKeywordIndex, error)

+ func (mdict *Mdict) LocateByKeywordEntry(entry *MDictKeywordEntry) ([]byte, error)

+ func (mdict *Mdict) LocateByKeywordIndex(index *MDictKeywordIndex) ([]byte, error)

+ func (mdict *Mdict) Lookup(word string) ([]byte, error)

+ func (mdict *Mdict) Name() string

+ func (mdict *Mdict) Resolve(entry IndexEntry) ([]byte, error)

+ func (mdict *Mdict) Title() string

+ func (mdict *Mdict) Version() string

+ type MdictAccessor struct

+ Filepath string

+ IsMDD bool

+ IsRecordEncrypted bool

+ IsUTF16 bool

+ func NewAccessor(mdict *Mdict) *MdictAccessor

+ func NewAccessorFromJSON(data []byte) (*MdictAccessor, error)

+ func (mdi *MdictAccessor) RetrieveDefByIndex(index *MDictKeywordIndex) ([]byte, error)

+ func (mdi *MdictAccessor) Serialize() ([]byte, error)

+ type MdictBase struct

+ func (mdict *MdictBase) GetKeyWordEntries() ([]*MDictKeywordEntry, error)

+ type MdictFS struct

+ func NewMdictFS(mdict *Mdict) *MdictFS

+ func (mfs *MdictFS) Open(name string) (fs.File, error)

+ type MdictFile struct

+ func (mf *MdictFile) Close() error

+ func (mf *MdictFile) Read(b []byte) (int, error)

+ func (mf *MdictFile) ReadDir(n int) ([]fs.DirEntry, error)

+ func (mf *MdictFile) Seek(offset int64, whence int) (int64, error)

+ func (mf *MdictFile) Stat() (fs.FileInfo, error)

+ type MdictFileInfo struct

+ func (mfi *MdictFileInfo) Info() (fs.FileInfo, error)

+ func (mfi *MdictFileInfo) IsDir() bool

+ func (mfi *MdictFileInfo) ModTime() time.Time

+ func (mfi *MdictFileInfo) Mode() fs.FileMode

+ func (mfi *MdictFileInfo) Name() string

+ func (mfi *MdictFileInfo) Size() int64

+ func (mfi *MdictFileInfo) Sys() interface{}

+ func (mfi *MdictFileInfo) Type() fs.FileMode

+ type MdictRecordBlockInfoListItem struct

+ func QueryRangeData(root *RecordBlockRangeTreeNode, queryRange int64) *MdictRecordBlockInfoListItem

+ type MdictType int

+ type MemoryFuzzyIndexStore struct

+ func NewMemoryFuzzyIndexStore() *MemoryFuzzyIndexStore

+ func (s *MemoryFuzzyIndexStore) Put(info DictionaryInfo, entries []IndexEntry) error

+ func (s *MemoryFuzzyIndexStore) Search(dictionaryName, query string, limit int) ([]SearchHit, error)

+ type MemoryIndexStore struct

+ func NewMemoryIndexStore() *MemoryIndexStore

+ func (s *MemoryIndexStore) GetExact(dictionaryName, keyword string) (IndexEntry, error)

+ func (s *MemoryIndexStore) PrefixSearch(dictionaryName, prefix string, limit int) ([]IndexEntry, error)

+ func (s *MemoryIndexStore) Put(info DictionaryInfo, entries []IndexEntry) error

+ type RecordBlockRangeTreeNode struct

+ type RedisIndexStore struct

+ func NewRedisIndexStore(client *redis.Client, opts ...RedisIndexStoreOption) *RedisIndexStore

+ func (s *RedisIndexStore) GetExact(dictionaryName, keyword string) (IndexEntry, error)

+ func (s *RedisIndexStore) PrefixSearch(dictionaryName, prefix string, limit int) ([]IndexEntry, error)

+ func (s *RedisIndexStore) Put(info DictionaryInfo, entries []IndexEntry) error

+ type RedisIndexStoreOption func(*RedisIndexStore)

+ func WithRedisIndexContext(ctx context.Context) RedisIndexStoreOption

+ func WithRedisKeyPrefix(prefix string) RedisIndexStoreOption

+ func WithRedisPrefixIndexMaxLen(maxLen int) RedisIndexStoreOption

+ type SearchHit struct

+ Entry IndexEntry

+ Score float64

+ Source string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL