fret-authoring 0.1.0

Authoring surfaces and integration helpers for editor-style Fret workflows.
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

use std::any::Any;
use std::future::Future;

use fret_query::ui::QueryElementContextExt as _;
pub use fret_query::with_query_client;
pub use fret_query::{
    CancellationToken, FutureSpawner, FutureSpawnerHandle, QueryCancelMode, QueryClient,
    QueryError, QueryErrorKind, QueryHandle, QueryKey, QueryPolicy, QueryRetryPolicy, QueryState,
    QueryStatus,
};
use fret_ui::UiHost;

use crate::UiWriter;

/// Query-style async resource helpers for authoring frontends.
///
/// This is a thin wrapper over `fret_query::ui::QueryElementContextExt` that works with any
/// authoring surface implementing `UiWriter`.
pub trait UiWriterQueryExt<H: UiHost>: UiWriter<H> {
    fn use_query<T: Any + Send + Sync + 'static>(
        &mut self,
        key: QueryKey<T>,
        policy: QueryPolicy,
        fetch: impl FnOnce(CancellationToken) -> Result<T, QueryError> + Send + 'static,
    ) -> QueryHandle<T>;

    fn use_query_async<T, Fut>(
        &mut self,
        key: QueryKey<T>,
        policy: QueryPolicy,
        fetch: impl FnOnce(CancellationToken) -> Fut + Send + 'static,
    ) -> QueryHandle<T>
    where
        T: Any + Send + Sync + 'static,
        Fut: Future<Output = Result<T, QueryError>> + Send + 'static;

    fn use_query_async_local<T, Fut>(
        &mut self,
        key: QueryKey<T>,
        policy: QueryPolicy,
        fetch: impl FnOnce(CancellationToken) -> Fut + 'static,
    ) -> QueryHandle<T>
    where
        T: Any + Send + Sync + 'static,
        Fut: Future<Output = Result<T, QueryError>> + 'static;

    fn invalidate_query<T: Any + Send + Sync + 'static>(&mut self, key: QueryKey<T>);

    fn invalidate_query_namespace(&mut self, namespace: &'static str);
}

impl<H: UiHost, W: UiWriter<H> + ?Sized> UiWriterQueryExt<H> for W {
    fn use_query<T: Any + Send + Sync + 'static>(
        &mut self,
        key: QueryKey<T>,
        policy: QueryPolicy,
        fetch: impl FnOnce(CancellationToken) -> Result<T, QueryError> + Send + 'static,
    ) -> QueryHandle<T> {
        self.with_cx_mut(|cx| cx.use_query(key, policy, fetch))
    }

    fn use_query_async<T, Fut>(
        &mut self,
        key: QueryKey<T>,
        policy: QueryPolicy,
        fetch: impl FnOnce(CancellationToken) -> Fut + Send + 'static,
    ) -> QueryHandle<T>
    where
        T: Any + Send + Sync + 'static,
        Fut: Future<Output = Result<T, QueryError>> + Send + 'static,
    {
        self.with_cx_mut(|cx| cx.use_query_async(key, policy, fetch))
    }

    fn use_query_async_local<T, Fut>(
        &mut self,
        key: QueryKey<T>,
        policy: QueryPolicy,
        fetch: impl FnOnce(CancellationToken) -> Fut + 'static,
    ) -> QueryHandle<T>
    where
        T: Any + Send + Sync + 'static,
        Fut: Future<Output = Result<T, QueryError>> + 'static,
    {
        self.with_cx_mut(|cx| cx.use_query_async_local(key, policy, fetch))
    }

    fn invalidate_query<T: Any + Send + Sync + 'static>(&mut self, key: QueryKey<T>) {
        self.with_cx_mut(|cx| {
            let _ = with_query_client(cx.app, |client, app| {
                client.invalidate(app, key);
            });
            cx.app.request_redraw(cx.window);
        });
    }

    fn invalidate_query_namespace(&mut self, namespace: &'static str) {
        self.with_cx_mut(|cx| {
            let _ = with_query_client(cx.app, |client, _app| {
                client.invalidate_namespace(namespace);
            });
            cx.app.request_redraw(cx.window);
        });
    }
}