Struct ForgeRuntime 

pub struct ForgeRuntime { /* private fields */ }

Editor 结构体代表编辑器的核心功能实现 负责管理文档状态、事件处理、插件系统和存储等核心功能

Implementations

impl ForgeRuntime

pub async fn create(options: RuntimeOptions) -> ForgeResult<Self>

创建新的编辑器实例

此方法会自动从以下位置加载XML schema配置：

1. 优先使用 config.extension.xml_schema_paths 中配置的路径
2. 如果没有配置，则尝试加载默认的 schema/main.xml
3. 如果都没有，则使用默认配置

参数

• options - 编辑器配置选项

返回值

• ForgeResult<Self> - 编辑器实例或错误

pub async fn from_xml_schema_path( xml_schema_path: &str, options: Option<RuntimeOptions>, config: Option<ForgeConfig>, ) -> ForgeResult<Self>

从指定路径的XML schema文件创建编辑器实例

参数

• xml_schema_path - XML schema文件路径
• options - 可选的RuntimeOptions配置
• config - 可选的ForgeConfig配置

返回值

• ForgeResult<Self> - 编辑器实例或错误

示例

use mf_core::ForgeRuntime;

// 从指定路径加载schema
let runtime = ForgeRuntime::from_xml_schema_path(
    "./schemas/document.xml",
    None,
    None
).await?;

pub async fn from_xml_schemas( xml_schema_paths: &[&str], options: Option<RuntimeOptions>, config: Option<ForgeConfig>, ) -> ForgeResult<Self>

从多个XML schema文件创建编辑器实例

参数

• xml_schema_paths - XML schema文件路径列表
• options - 可选的RuntimeOptions配置
• config - 可选的ForgeConfig配置

返回值

• ForgeResult<Self> - 编辑器实例或错误

pub async fn from_xml_content( xml_content: &str, options: Option<RuntimeOptions>, config: Option<ForgeConfig>, ) -> ForgeResult<Self>

从XML内容字符串创建编辑器实例

参数

• xml_content - XML schema内容
• options - 可选的RuntimeOptions配置
• config - 可选的ForgeConfig配置

返回值

• ForgeResult<Self> - 编辑器实例或错误

示例

use mf_core::{ForgeRuntime, types::RuntimeOptions};

let xml = r#"<schema>...</schema>"#;

// 使用默认选项
let runtime = ForgeRuntime::from_xml_content(xml, None, None).await?;

// 使用自定义选项
let mut options = RuntimeOptions::default();
options.set_history_limit(Some(100));
let runtime = ForgeRuntime::from_xml_content(xml, Some(options), None).await?;

pub async fn create_with_config( options: RuntimeOptions, config: ForgeConfig, ) -> ForgeResult<Self>

使用指定配置创建编辑器实例

此方法会自动从以下位置加载XML schema配置：

1. 优先使用 config.extension.xml_schema_paths 中配置的路径
2. 如果没有配置，则尝试加载默认的 schema/main.xml
3. 如果都没有，则使用默认配置

参数

• options - 编辑器配置选项
• config - 编辑器配置

返回值

• ForgeResult<Self> - 编辑器实例或错误

pub async fn destroy(&mut self) -> ForgeResult<()>

销毁编辑器实例

pub async fn emit_event(&mut self, event: Event) -> ForgeResult<()>

pub async fn run_before_middleware( &mut self, transaction: &mut Transaction, ) -> ForgeResult<()>

pub async fn run_after_middleware( &mut self, state: &mut Option<Arc<State>>, transactions: &mut Vec<Arc<Transaction>>, ) -> ForgeResult<()>

pub async fn command(&mut self, command: Arc<dyn Command>) -> ForgeResult<()>

pub async fn command_with_meta( &mut self, command: Arc<dyn Command>, description: String, meta: Value, ) -> ForgeResult<()>

pub async fn dispatch(&mut self, transaction: Transaction) -> ForgeResult<()>

处理编辑器事务的核心方法

参数

• transaction - 要处理的事务对象

返回值

• EditorResult<()> - 处理结果，成功返回 Ok(()), 失败返回错误

pub async fn dispatch_with_meta( &mut self, transaction: Transaction, description: String, meta: Value, ) -> ForgeResult<()>

更新编辑器状态并记录到历史记录 包含描述和元信息

pub async fn update_state(&mut self, state: Arc<State>) -> ForgeResult<()>

更新编辑器状态并记录到历史记录 不包含描述和元信息

pub async fn update_state_with_meta( &mut self, state: Arc<State>, transactions: Vec<Arc<Transaction>>, description: String, meta: Value, ) -> ForgeResult<()>

更新编辑器状态并记录到历史记录 包含描述和元信息

pub async fn register_plugin(&mut self) -> ForgeResult<()>

pub async fn unregister_plugin(&mut self, plugin_key: String) -> ForgeResult<()>

pub fn doc(&self) -> Arc<NodePool>

共享的基础实现方法

pub fn get_options(&self) -> &RuntimeOptions

pub fn get_config(&self) -> &ForgeConfig

获取当前配置

pub fn update_config(&mut self, config: ForgeConfig)

更新配置

pub fn get_state(&self) -> &Arc<State>

pub fn get_schema(&self) -> Arc<Schema>

pub fn get_event_bus(&self) -> &EventBus<Event>

pub fn get_tr(&self) -> Transaction

pub fn undo(&mut self)

pub fn redo(&mut self)

pub fn jump(&mut self, n: isize)

pub fn get_history_manager(&self) -> &HistoryManager<HistoryEntryWithMeta>

Trait Implementations

impl Drop for ForgeRuntime

fn drop(&mut self)

Executes the destructor for this type.

impl RuntimeTrait for ForgeRuntime

fn dispatch<'life0, 'async_trait>( &'life0 mut self, transaction: Transaction, ) -> Pin<Box<dyn Future<Output = ForgeResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

分发事务到运行时处理

fn dispatch_with_meta<'life0, 'async_trait>( &'life0 mut self, transaction: Transaction, description: String, meta: Value, ) -> Pin<Box<dyn Future<Output = ForgeResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

分发事务(包含元信息)

fn command<'life0, 'async_trait>( &'life0 mut self, command: Arc<dyn Command>, ) -> Pin<Box<dyn Future<Output = ForgeResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

执行命令

fn command_with_meta<'life0, 'async_trait>( &'life0 mut self, command: Arc<dyn Command>, description: String, meta: Value, ) -> Pin<Box<dyn Future<Output = ForgeResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

执行命令(包含元信息)

fn get_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ForgeResult<Arc<State>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

获取当前状态

fn get_tr<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ForgeResult<Transaction>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

获取新事务

fn get_schema<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ForgeResult<Arc<Schema>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

获取Schema

fn undo<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ForgeResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

撤销操作

fn redo<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ForgeResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

重做操作

fn jump<'life0, 'async_trait>( &'life0 mut self, steps: isize, ) -> Pin<Box<dyn Future<Output = ForgeResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

跳转到指定历史位置

fn get_config(&self) -> &ForgeConfig

获取运行时配置

fn update_config(&mut self, config: ForgeConfig)

更新运行时配置

fn get_options(&self) -> &RuntimeOptions

获取运行时选项

fn destroy<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ForgeResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

销毁运行时

fn doc<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ForgeResult<Arc<NodePool>>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

获取文档