docs/generated/contracts.mdgenerated from code

Reference · 1 min read

stuck

Contracts: stuck.

Source: crates/lvcs-doc/src/stuck.rs.

ruston main
1/// Outputs of the stuck lister.2#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]3pub enum ListerOutput {4    /// The answer to a [`StuckAsked`]: at most `STATUS_STUCK_MAX`5    /// documents holding changes they can't take in, those it can't read6    /// before those keeping a refusal, each in document address order7    /// (discussion:owner/671 rule 6).8    Stuck { reply: u64, docs: Vec<StuckDoc> },9}1011/// The document at `address` is stuck as `doc` says, or, with `None`, no12/// longer stuck (the router's [`crate::router::RouterOutput::StuckChanged`]).13#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]14pub struct StuckChanged {15    pub address: String,16    pub doc: Option<StuckDoc>,17}1819/// The router restarted, which forgets what was set aside (it is kept in20/// memory only, discussion:owner/671 rule 2); stored refusals come again.21#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]22pub struct StuckForgotten;2324/// Which documents are stuck, answered with [`ListerOutput::Stuck`]: one25/// question for `status`, never one per document (discussion:owner/67126/// rule 6).27#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]28pub struct StuckAsked {29    pub reply: u64,30}