Interface Rpc

server/src/rpc_nodeget.rs:35–105

/// 命名空间分隔符为 `_`（自定义 jsonrpsee fork）。
#[rpc(server, namespace = "nodeget-server")]
pub trait Rpc {
    /// 返回服务器运行状态确认字符串
    #[method(name = "hello")]
    async fn hello(&self) -> String;

    /// 返回服务器版本信息（语义化版本 + 构建信息）
    #[method(name = "version")]
    async fn version(&self) -> Value;

    /// 返回服务器 UUID（从全局 Config 读取）
    #[method(name = "uuid")]
    async fn uuid(&self) -> String;

    /// 读取服务器配置文件内容
    ///
    /// - token：身份认证凭据
    #[method(name = "read_config")]
    async fn read_config(&self, token: String) -> RpcResult<String>;

    /// 编辑服务器配置文件并触发热重载
    ///
    /// - token：身份认证凭据
    /// - `config_string`：完整的 TOML 配置文本
    #[method(name = "edit_config")]
    async fn edit_config(&self, token: String, config_string: String) -> RpcResult<bool>;

    /// 查询数据库存储占用（表大小、行数等）
    ///
    /// - token：身份认证凭据
    #[method(name = "database_storage")]
    async fn database_storage(&self, token: String) -> RpcResult<Box<RawValue>>;

    /// 查询内存日志缓冲区中的历史日志
    ///
    /// - token：身份认证凭据（需 Super Token）
    #[method(name = "log")]
    async fn log(&self, token: String) -> RpcResult<Box<RawValue>>;

    /// 实时日志流订阅
    ///
    /// - token：身份认证凭据（需 Super Token）
    /// - `log_filter`：`EnvFilter` 格式的过滤器字符串，如 `"info,server=debug"`
    #[subscription(name = "stream_log", item = Value, unsubscribe = "unsubscribe_stream_log")]
    async fn stream_log(&self, token: String, log_filter: String) -> SubscriptionResult;

    /// 服务器二进制自更新
    ///
    /// - token：身份认证凭据（需 Super Token）
    /// - tag：目标版本标签，如 `"v0.5.0"`
    #[method(name = "self_update")]
    async fn self_update(&self, token: String, tag: String) -> RpcResult<()>;

    /// 执行原始 SQL 语句
    ///
    /// - token：身份认证凭据
    /// - sql：SQL 语句文本
    /// - params：可选的参数绑定（JSON 对象）
    #[method(name = "exec_sql")]