mirror of
https://github.com/storytold/craft-libs.git
synced 2026-11-17 20:25:06 +00:00
* feat: add craft-control (control channel protocol) Port from solidcraft: the control channel any app may share, no UI toolkit. - Per-launch token files (32 random bytes, user-only permissions) - Loopback server with token-based authentication - Client that talks to the loopback server - Request/response types (ControlRequest, ControlResponse) - Document watch for subscribed connections waiting on changes - Effect type for requests still running when they finish Desktop-only (wasm32 excluded): uses getrandom for token generation. No external dependencies beyond serde and serde_json. * fix: update test directory names from solidcraft-control to craft-control * Record control crate dependencies in workspace lockfile * re-trigger CI * chore(lock): keep the wasm-bindgen family at the version main's runners install
28 lines
1.4 KiB
Rust
28 lines
1.4 KiB
Rust
//! What a client is told about a control request that outlasts its wait (docs/control-protocol.md,
|
|
//! #1618): the app's control server and a bridged client both say what the request still does when
|
|
//! it finishes. Which requests do what is the app's to say.
|
|
|
|
/// What a request still running does when it finishes.
|
|
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
|
pub enum Effect {
|
|
/// It only reads (the document, the window or the command list): nothing changes.
|
|
ReadsOnly,
|
|
/// It writes a file (an export, a save, a render to a path); the document stays as it is.
|
|
WritesFile,
|
|
/// It changes the document (or may: anything not known to read or only write a file).
|
|
Changes,
|
|
}
|
|
|
|
impl Effect {
|
|
/// What happens when the request finishes, for a message: "it only reads: nothing changes",
|
|
/// "it was not cancelled and will still write the file when it finishes; the design does not
|
|
/// change", … `document` is what the app calls its document ("design").
|
|
pub fn when_done(self, document: &str) -> String {
|
|
match self {
|
|
Effect::ReadsOnly => "it only reads: nothing changes".into(),
|
|
Effect::WritesFile => format!("it was not cancelled and will still write the file when it finishes; the {document} does not change"),
|
|
Effect::Changes => "it was not cancelled and will still apply when it finishes".into(),
|
|
}
|
|
}
|
|
}
|