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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
use TryStreamExt;
use ;
use WatchStreamExt;
use ;
use mpsc;
use JoinHandle;
use ;
use crateResult;
use crate;
use crate;
// ---------------------------------------------------------------------------
// Private core helpers
// ---------------------------------------------------------------------------
async
// ---------------------------------------------------------------------------
// Generic public API
// ---------------------------------------------------------------------------
/// Watch resources of type `T` and send a signal on `tx` whenever a resource
/// is applied (created or updated).
///
/// An optional `label_selector` narrows the watch to matching resources only.
/// Pass `None` to watch all resources of the given type.
///
/// Pass [`Cluster`] or [`Namespaced`] as the `scope` argument to select the
/// correct API surface at compile time. Prefer the convenience wrappers
/// ([`watch_namespaced`], [`watch_cluster`], [`watch_namespaced_by_label`],
/// [`watch_cluster_by_label`]) for the common cases — they are thin wrappers
/// around this function.
///
/// Returns a [`JoinHandle`] for the background task. The task shuts down
/// automatically when all receivers are dropped.
///
/// # Examples
///
/// ```no_run
/// use koprs::error::KubeGenericError;
/// use kube::Client;
/// use koprs::watcher::watch;
/// use koprs::scope::Namespaced;
/// use koprs::traits::NamespacedResource;
/// use tokio::sync::mpsc;
///
/// # async fn example<MyCR: NamespacedResource>(client: Client) -> Result<(), KubeGenericError> {
/// let (tx, mut rx) = mpsc::channel(16);
/// let _handle = watch::<MyCR, _>(
/// client,
/// Namespaced("my-namespace"),
/// None,
/// tx,
/// ).await?;
///
/// while let Some(()) = rx.recv().await {
/// println!("Resource changed!");
/// }
/// # Ok(())
/// # }
/// ```
pub async
// ---------------------------------------------------------------------------
// Convenience wrappers — namespaced
// ---------------------------------------------------------------------------
/// Watch all resources of type `T` in a namespace and send a signal on `tx`
/// whenever a resource is applied (created or updated).
///
/// Delegates to [`watch`] with [`Namespaced`] as the scope and no label
/// selector. The resource type `T` must implement [`NamespacedResource`],
/// which the compiler enforces — passing a cluster-scoped type is a compile
/// error.
///
/// Returns a [`JoinHandle`] for the background task. The task shuts down
/// automatically when all receivers are dropped.
///
/// # Examples
///
/// ```no_run
/// use koprs::error::KubeGenericError;
/// use kube::Client;
/// use koprs::watcher::watch_namespaced;
/// use koprs::traits::NamespacedResource;
/// use tokio::sync::mpsc;
///
/// # async fn example<MyCR: NamespacedResource>(client: Client) -> Result<(), KubeGenericError> {
/// let (tx, mut rx) = mpsc::channel(16);
/// let _handle = watch_namespaced::<MyCR>(client, "my-namespace", tx).await?;
///
/// while let Some(()) = rx.recv().await {
/// println!("Resource changed!");
/// }
/// # Ok(())
/// # }
/// ```
pub async
/// Watch resources of type `T` in a namespace matching a label selector, and
/// send a signal on `tx` whenever a matching resource is applied (created or
/// updated).
///
/// Delegates to [`watch`] with [`Namespaced`] as the scope. The resource type
/// `T` must implement [`NamespacedResource`].
///
/// Returns a [`JoinHandle`] for the background task. The task shuts down
/// automatically when all receivers are dropped.
///
/// # Examples
///
/// ```no_run
/// use koprs::error::KubeGenericError;
/// use kube::Client;
/// use koprs::watcher::watch_namespaced_by_label;
/// use koprs::traits::NamespacedResource;
/// use tokio::sync::mpsc;
///
/// # async fn example<MyCR: NamespacedResource>(client: Client) -> Result<(), KubeGenericError> {
/// let (tx, mut rx) = mpsc::channel(16);
/// let _handle = watch_namespaced_by_label::<MyCR>(
/// client,
/// "my-namespace",
/// "app=my-operator",
/// tx,
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async
// ---------------------------------------------------------------------------
// Convenience wrappers — cluster-scoped
// ---------------------------------------------------------------------------
/// Watch all resources of type `T` cluster-wide and send a signal on `tx`
/// whenever a resource is applied (created or updated).
///
/// Delegates to [`watch`] with [`Cluster`] as the scope and no label selector.
/// The resource type `T` must implement [`ClusterResource`], which the
/// compiler enforces — passing a namespace-scoped type is a compile error.
///
/// Returns a [`JoinHandle`] for the background task. The task shuts down
/// automatically when all receivers are dropped.
///
/// # Examples
///
/// ```no_run
/// use koprs::error::KubeGenericError;
/// use kube::Client;
/// use koprs::watcher::watch_cluster;
/// use koprs::traits::ClusterResource;
/// use tokio::sync::mpsc;
///
/// # async fn example<MyCR: ClusterResource>(client: Client) -> Result<(), KubeGenericError> {
/// let (tx, mut rx) = mpsc::channel(16);
/// let _handle = watch_cluster::<MyCR>(client, tx).await?;
///
/// while let Some(()) = rx.recv().await {
/// println!("Resource changed!");
/// }
/// # Ok(())
/// # }
/// ```
pub async
/// Watch resources of type `T` cluster-wide matching a label selector, and
/// send a signal on `tx` whenever a matching resource is applied (created or
/// updated).
///
/// Delegates to [`watch`] with [`Cluster`] as the scope. The resource type
/// `T` must implement [`ClusterResource`].
///
/// Returns a [`JoinHandle`] for the background task. The task shuts down
/// automatically when all receivers are dropped.
///
/// # Examples
///
/// ```no_run
/// use koprs::error::KubeGenericError;
/// use kube::Client;
/// use koprs::watcher::watch_cluster_by_label;
/// use koprs::traits::ClusterResource;
/// use tokio::sync::mpsc;
///
/// # async fn example<MyCR: ClusterResource>(client: Client) -> Result<(), KubeGenericError> {
/// let (tx, mut rx) = mpsc::channel(16);
/// let _handle = watch_cluster_by_label::<MyCR>(
/// client,
/// "app=my-operator",
/// tx,
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async