Skip to main content

Module types

Module types 

Source

Structs§

ExecutionContext
执行上下文
ListItem
插件返回给宿主的搜索结果项。 服务于结果聚合、排序与 UI 渲染。
PanelInteraction
插件面板响应携带的通用交互策略。 服务于宿主处理输入查询触发时机,不属于插件持久化配置。
PanelKeyBinding
插件面板按键绑定 —— 声明式按键契约的最小单元。 服务于宿主解释执行:插件声明按键 → 宿主翻译为动作语义。
PluginContext
请求级上下文,在宿主与插件之间共享。 服务于插件生命周期/查询/动作调用,并携带日志关联 ID。
PluginMetadata
单个插件实例的静态元数据描述。 服务于注册中心索引、触发词路由与插件发现/展示。 第三方插件的取值由宿主从 manifest.toml 构造,内置插件由代码构造。
Query
发送给插件查询处理器的标准化查询载荷。 服务于查询分发和插件侧搜索逻辑。
QueryRevisionGate
查询版本门控:宿主在会写会话的查询入口(GUI 查询、热键唤醒)分配 单调递增版本号,供插件在写入跨查询共享状态(如翻译结果缓存)前判断 自身查询是否已被更新的查询取代。
ResultAction
挂载在查询结果上的动作项。 服务于用户触发后的 Plugin::execute_action 执行流程。
ScoreDetail
ScoredCandidate
SearchCandidate

Enums§

ExecutionError
执行错误
ExecutionTarget
执行目标
KeywordInputSource
关键词优化器输入来源 —— 候选关键词管道中的产物引用。
PanelKeyAction
面板按键动作 —— 宿主解释执行的动作语义。 服务于插件面板的完整按键权声明(键盘状态机契约)。
PanelQueryTrigger
插件面板查询触发方式的通用语义。 服务于宿主判断行内插件模式下输入后是否自动发起查询。
PluginError
插件层统一错误类型。 服务于生命周期/查询/动作/设置相关错误在宿主与插件间传播。
PluginKind
插件种类 —— 区分内置(编译进二进制)与第三方(外部子进程)。
PluginMode
插件形态 —— 决定唤醒方式与展示形态。 与 PluginKind(内置/第三方)正交;序列化键名 “inline”/“panel”。
QueryChannel
查询来源通道 —— 标识查询进入后端的入口。
QueryResponse
插件查询响应 —— 一次查询的展示结果契约(跨 IPC 序列化,字段键名与前端 BridgeQueryResponse.mode 词表对齐)。
RegistrationError
注册错误
ScoreDetailKind
分数明细的计入方式 —— 标识该项是加权加分还是乘法系数。
TargetType
执行目标类型枚举,用于 ActionExecutor 注册和查找。 序列化键名显式标注(serde-rename 契约),与 as_str() 前端词表一致。

Traits§

ActionExecutor
动作执行器 trait 每个 Executor 可以声明支持多种 TargetType 和多种 Action Executor 继承 Configurable,以支持统一配置管理和发现
DataSource
KeywordInjector
KeywordOptimizer
ScoreBooster
SearchEngine

Type Aliases§

CandidateId