docs/generated/contracts.mdgenerated from code

Reference · 1 min read

live-documents

Contracts: live-documents.

Source: crates/lvcs-runtime/src/documents.rs.

ruston main
1/// A running document's [`DocPolicies`] (discussion:owner/354 and discussion:owner/403): each2/// kind's machine on its own task in its project's scope, its steps on3/// Tokio's blocking pool, each journaled to `close` as the [`DocEvent`]4/// its owner delivered.5#[derive(Clone)]6pub struct Live {7    /// The scope its machine runs in.8    scope: TokioScope,9    /// Where each step goes.10    close: Close<DocEvent, DocOutput, DocFingerprint>,11    /// Set once its machine's task ended, however it ended.12    ended: super::Ended,13    /// Set by the step that closed its machine (discussion:owner/778).14    halted: super::Halted,15    /// What its scheduler hands back at a stop (discussion:owner/653).16    returned: super::Returned<DocEvent>,17    /// Its address, for a watchdog sample.18    address: String,19}2021/// A document actor as the daemon runs it.22pub type LiveDocument = lvcs_doc::Document<Live>;