reovim-client-model 0.14.4

Common client model for Reovim (platform-agnostic abstractions)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//! Overlay types for popups, menus, and floating UI elements.
//!
//! Overlays are logical UI elements sent from the server. The client
//! is responsible for rendering them according to platform capabilities.

use serde::{Deserialize, Serialize};

use super::origin::SemanticOrigin;

/// State of an interactive overlay (e.g., completion menu).
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "wasm", derive(tsify_next::Tsify))]
#[cfg_attr(feature = "wasm", tsify(into_wasm_abi, from_wasm_abi))]
pub struct OverlayState {
    /// Currently selected index (for lists).
    pub selected_index: Option<u32>,
    /// Current filter text (for fuzzy matching).
    pub filter: String,
    /// Scroll offset for long lists.
    pub scroll_offset: u32,
    /// Whether the overlay is loading data.
    pub loading: bool,
}

impl OverlayState {
    /// Create a new overlay state with default values.
    #[must_use]
    pub const fn new() -> Self {
        Self {
            selected_index: None,
            filter: String::new(),
            scroll_offset: 0,
            loading: false,
        }
    }

    /// Create a state with a selected index.
    #[must_use]
    pub const fn with_selection(index: u32) -> Self {
        Self {
            selected_index: Some(index),
            filter: String::new(),
            scroll_offset: 0,
            loading: false,
        }
    }
}

/// A logical overlay from the server.
///
/// Contains all information needed to render an overlay, but no
/// platform-specific details. The client interprets this into
/// rendered state appropriate for its platform.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "wasm", derive(tsify_next::Tsify))]
#[cfg_attr(feature = "wasm", tsify(into_wasm_abi, from_wasm_abi))]
pub struct LogicalOverlay {
    /// Unique identifier for this overlay instance.
    pub id: String,
    /// Semantic origin — WHAT this data relates to (informational, not directive).
    /// Clients decide positioning independently based on this metadata.
    pub origin: Option<SemanticOrigin>,
    /// Overlay type (e.g., "completion", "hover", "signature").
    pub kind: String,
    /// Payload data (contents depend on kind).
    pub data: serde_json::Value,
    /// Interactive state.
    pub state: OverlayState,
    /// Priority for z-ordering (higher = on top).
    pub priority: u32,
}

impl LogicalOverlay {
    /// Create a new logical overlay.
    #[must_use]
    pub fn new(id: impl Into<String>, kind: impl Into<String>) -> Self {
        Self {
            id: id.into(),
            origin: None,
            kind: kind.into(),
            data: serde_json::Value::Null,
            state: OverlayState::new(),
            priority: 0,
        }
    }

    /// Set the semantic origin.
    #[must_use]
    pub const fn with_origin(mut self, origin: SemanticOrigin) -> Self {
        self.origin = Some(origin);
        self
    }

    /// Set the data payload.
    #[must_use]
    pub fn with_data(mut self, data: serde_json::Value) -> Self {
        self.data = data;
        self
    }

    /// Set the priority.
    #[must_use]
    pub const fn with_priority(mut self, priority: u32) -> Self {
        self.priority = priority;
        self
    }

    /// Set the initial state.
    #[must_use]
    #[cfg_attr(coverage_nightly, coverage(off))]
    pub fn with_state(mut self, state: OverlayState) -> Self {
        self.state = state;
        self
    }
}

#[cfg(test)]
#[path = "overlay_tests.rs"]
mod tests;