windows-reactor 0.100.0

Declarative Windows UI library for Rust
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use super::*;

pub(super) struct PropertyCommit {
    pub(super) node: NodeId,
    pub(super) property: PropertyId,
    pub(super) value: Option<PropertyValue>,
}

pub(super) struct ReferenceCommit {
    pub(super) node: NodeId,
    pub(super) old: Option<NativeElementRef>,
    pub(super) new: Option<NativeElementRef>,
}

pub(super) struct UpdatePlan {
    pub(super) commands: Vec<Command>,
    pub(super) commits: Vec<PropertyCommit>,
    pub(super) diagnostics: Vec<PumpDiagnostic>,
    pub(super) reference_commits: Vec<ReferenceCommit>,
    pub(super) identity: WindowToken,
    pub(super) reconcile_observations: bool,
    pub(super) post_publish_commands: Vec<Command>,
    pub(super) post_publish_windows: Vec<View>,
}

#[derive(Default)]
pub(super) struct ComponentChanges {
    pub(super) composed: IdSet<ComponentToken>,
    pub(super) context_reads: IdMap<ComponentToken, ContextDependencies>,
    pub(super) deferred: IdSet<ComponentToken>,
    pub(super) recompose: IdSet<ComponentToken>,
    pub(super) reserved: Vec<ComponentToken>,
    pub(super) retired: Vec<ComponentToken>,
    pub(super) touched: IdSet<ComponentToken>,
    pub(super) host_requests: Vec<HostRequest>,
}

#[derive(Clone, Copy)]
pub(super) enum PlanningFailure {
    Discard,
    Rearm,
}

pub(super) enum LocalComponentUpdate {
    Plan(LocalCandidate),
    Fallback(ComponentRender),
    Unavailable,
}

pub(super) struct LocalCandidate {
    pub(super) context_reads: ContextDependencies,
    pub(super) node: NodeId,
    pub(super) desired: MountedProps,
    pub(super) exit_transition: Option<ExitTransition>,
    pub(super) reference: Option<NativeElementRef>,
    pub(super) plan: UpdatePlan,
}

pub(super) struct ComponentCandidate {
    pub(super) activate_window: bool,
    pub(super) changes: ComponentChanges,
    pub(super) next_version: u64,
    pub(super) plan: UpdatePlan,
    pub(super) planning_failure: PlanningFailure,
    pub(super) root: NodeId,
    pub(super) tree: Tree,
    pub(super) window: NodeId,
}

pub(super) enum CandidateState {
    Tree {
        tree: Tree,
        root: NodeId,
    },
    Native {
        node: NodeId,
        desired: MountedProps,
        exit_transition: Option<ExitTransition>,
        reference: Option<NativeElementRef>,
    },
}

#[allow(
    clippy::large_enum_variant,
    reason = "boxing component changes would allocate on every component publication"
)]
pub(super) enum FrontendChanges {
    #[cfg(test)]
    Element(Element),
    Component(ComponentChanges),
    Local {
        context_reads: ContextDependencies,
        token: ComponentToken,
    },
}

impl UpdatePlan {
    pub(super) fn new(identity: WindowToken) -> Self {
        Self {
            commands: Vec::new(),
            commits: Vec::new(),
            diagnostics: Vec::new(),
            reference_commits: Vec::new(),
            identity,
            reconcile_observations: false,
            post_publish_commands: Vec::new(),
            post_publish_windows: Vec::new(),
        }
    }

    pub(super) fn push(&mut self, command: Command) -> usize {
        let index = self.commands.len();
        self.commands.push(command);
        index
    }

    pub(super) fn prepend(&mut self, command: Command) {
        self.commands.insert(0, command);
    }

    pub(super) fn synchronize_children(
        &mut self,
        parent: NodeId,
        slot: Option<SlotId>,
        children: Vec<NodeId>,
    ) {
        if let Some(index) = self.commands.iter().position(|command| {
            matches!(
                command,
                Command::SynchronizeChildren {
                    parent: current_parent,
                    slot: current_slot,
                    ..
                } if *current_parent == parent && *current_slot == slot
            )
        }) {
            self.commands.remove(index);
        }
        self.push(Command::SynchronizeChildren {
            parent,
            slot,
            children,
        });
    }
}