Skip to main content

SnapshotSubscriber

Struct SnapshotSubscriber 

Source
pub struct SnapshotSubscriber<E: EventStore + 'static> { /* private fields */ }

Implementations§

Source§

impl<E: EventStore + 'static> SnapshotSubscriber<E>

Source

pub fn new( store: Arc<E>, options: PersistOptions, default_doc_id: impl Into<String>, ) -> Self

Examples found in repository?
examples/01_runtime_with_persistence.rs (lines 34-38)
16async fn main() -> ForgeResult<()> {
17    // 1) 构造事件存储(SQLite WAL)
18    let store = SqliteEventStore::open(
19        "./data/persistence_demo.sqlite",
20        CommitMode::AsyncDurable { group_window_ms: 8 },
21    )
22    .await?;
23
24    // 2) 配置持久化选项(定期快照)
25    let persist_opts = PersistOptions {
26        commit_mode: CommitMode::AsyncDurable { group_window_ms: 8 },
27        snapshot_every_n_events: 1000,
28        snapshot_every_bytes: 8 * 1024 * 1024,
29        snapshot_every_ms: 5 * 60 * 1000,
30        compression: true,
31    };
32
33    // 3) 注入持久化订阅者(由事件驱动持久化与快照)
34    let subscriber = Arc::new(SnapshotSubscriber::new(
35        store.clone(),
36        persist_opts.clone(),
37        "default_doc",
38    ));
39
40    let options =
41        EditorOptionsBuilder::new().add_event_handler(subscriber).build();
42
43    // 4) 从 XML schema 加载运行时(注意路径相对于工作目录,必要时调整为 "../../schema/main.xml")
44    let xml_path = "schema/main.xml";
45    let mut editor =
46        ForgeAsyncRuntime::from_xml_schema_path(xml_path, Some(options), None)
47            .await?;
48
49    // 5) 构造一个新增节点事务(dwgc)并分发
50    let doc = editor.doc();
51    let mut tr = editor.get_tr();
52    let schema = &tr.schema;
53    // 依赖 main.xml 中定义的 <node name="dwgc" ...>
54    let factory = schema.factory();
55    let dw_node = factory.create_tree("dwgc", None, None, vec![], None)?;
56    tr.add_node(doc.root_id().clone(), vec![dw_node])?;
57    editor.dispatch(tr).await?;
58    // 睡眠五秒,等待持久化与快照
59    tokio::time::sleep(std::time::Duration::from_secs(5)).await;
60    let state = editor.get_state();
61    println!("事务已分发并持久化,当前版本: {}", state.version);
62
63    // 如需导出/导入演示,请运行:
64    // cargo run -p moduforge-persistence --example export_doc
65    // cargo run -p moduforge-persistence --example export_zip
66    Ok(())
67}

Trait Implementations§

Source§

impl<E: EventStore + 'static> Clone for SnapshotSubscriber<E>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<E: EventStore + 'static> Debug for SnapshotSubscriber<E>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<E: EventStore + 'static> EventHandler<Event> for SnapshotSubscriber<E>

Source§

fn handle<'life0, 'life1, 'async_trait>( &'life0 self, event: &'life1 Event, ) -> Pin<Box<dyn Future<Output = ForgeResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Auto Trait Implementations§

§

impl<E> !RefUnwindSafe for SnapshotSubscriber<E>

§

impl<E> Freeze for SnapshotSubscriber<E>
where Arc<E>: Freeze,

§

impl<E> Send for SnapshotSubscriber<E>
where Arc<E>: Send,

§

impl<E> Sync for SnapshotSubscriber<E>
where Arc<E>: Sync,

§

impl<E> Unpin for SnapshotSubscriber<E>
where Arc<E>: Unpin,

§

impl<E> UnsafeUnpin for SnapshotSubscriber<E>
where Arc<E>: UnsafeUnpin,

§

impl<E> UnwindSafe for SnapshotSubscriber<E>
where Arc<E>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Message for T
where T: Any + Send + 'static,

Source§

fn from_boxed(m: BoxedMessage) -> Result<Self, BoxedDowncastErr>

Convert a BoxedMessage to this concrete type
Source§

fn box_message(self, pid: &ActorId) -> Result<BoxedMessage, BoxedDowncastErr>

Convert this message to a BoxedMessage
Source§

impl<T> OutputMessage for T
where T: Message + Clone,

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> State for T
where T: Any + Send + 'static,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more