foundation_core 0.0.6

Central crate for all foundation crates for the ewe-platform project
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
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
//! Stream-to-Future async bridge for valtron.
//!
//! Wrapper types that convert any [`StreamIterator`] into standard Rust `Future`
//! and `Stream` types, bridging valtron's sync iterator model with async code.

use core::future::Future;
use core::pin::Pin;
use core::task::{Context, Poll};
use futures_core::Stream as FuturesStream;

use super::streams::{Stream, StreamIterator, StreamSpread};
use super::wake::{WakeResult, WakeableStream};

// ============================================================================
// StreamCollectFuture
// ============================================================================

/// Drives a [`StreamIterator`] to completion, collecting all `Next` values into a `Vec`.
#[cfg(any(feature = "std", feature = "alloc"))]
pub struct StreamCollectFuture<SI: StreamIterator> {
    inner: Option<SI>,
    collected: Vec<SI::D>,
}

#[cfg(any(feature = "std", feature = "alloc"))]
impl<SI: StreamIterator> StreamCollectFuture<SI> {
    pub fn new(iter: SI) -> Self {
        Self {
            inner: Some(iter),
            collected: Vec::new(),
        }
    }
}

#[cfg(any(feature = "std", feature = "alloc"))]
impl<SI> Future for StreamCollectFuture<SI>
where
    SI: WakeableStream + Unpin,
    SI::D: Unpin,
{
    type Output = Vec<SI::D>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let this = self.get_mut();
        let iter = this.inner.as_mut().expect("polled after completion");

        loop {
            match iter.next() {
                Some(Stream::Next(v)) => this.collected.push(v),
                Some(Stream::Ignore) => {}
                Some(Stream::Spread(items)) => {
                    // A Spread carries multiple Done payloads; collect every one
                    // and skip Pending payloads (they are not values to collect).
                    for item in items {
                        if let StreamSpread::Done(v) = item {
                            this.collected.push(v);
                        }
                    }
                }
                Some(
                    Stream::Pending(_)
                    | Stream::Delayed(_)
                    | Stream::Init
                    | Stream::Wait,
                ) => {
                    let waker = cx.waker().clone();
                    match iter.wake(Box::new(move || waker.wake_by_ref())) {
                        WakeResult::Successful => {
                            // Register-then-recheck: a `push` between our last
                            // `next()` (empty) and `wake()` already fired the
                            // still-empty registry and will not re-fire. Catch it
                            // here; park only if still non-target.
                            match iter.next() {
                                Some(Stream::Next(v)) => this.collected.push(v),
                                Some(Stream::Ignore) => {}
                                Some(Stream::Spread(items)) => {
                                    for item in items {
                                        if let StreamSpread::Done(v) = item {
                                            this.collected.push(v);
                                        }
                                    }
                                }
                                Some(
                                    Stream::Pending(_)
                                    | Stream::Delayed(_)
                                    | Stream::Init
                                    | Stream::Wait,
                                ) => return Poll::Pending,
                                None => {
                                    return Poll::Ready(std::mem::take(&mut this.collected));
                                }
                            }
                        }
                        WakeResult::NotSupported => {
                            cx.waker().wake_by_ref();
                            return Poll::Pending;
                        }
                    }
                }
                None => {
                    return Poll::Ready(std::mem::take(&mut this.collected));
                }
            }
        }
    }
}

// ============================================================================
// StreamReadyFuture
// ============================================================================

/// Drives a [`StreamIterator`] until the first `Next(D)`, returning the value and remaining iterator.
pub struct StreamReadyFuture<SI: StreamIterator> {
    inner: Option<SI>,
}

impl<SI: StreamIterator> StreamReadyFuture<SI> {
    pub fn new(iter: SI) -> Self {
        Self { inner: Some(iter) }
    }
}

impl<SI> Future for StreamReadyFuture<SI>
where
    SI: WakeableStream + Unpin,
{
    type Output = Option<(SI::D, SI)>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let this = self.get_mut();
        let iter = this.inner.as_mut().expect("polled after completion");

        loop {
            match iter.next() {
                Some(Stream::Next(v)) => {
                    let remaining = this.inner.take().expect("inner should exist");
                    return Poll::Ready(Some((v, remaining)));
                }
                Some(Stream::Ignore) => {}
                Some(Stream::Pending(_) | Stream::Delayed(_) | Stream::Init | Stream::Wait) => {
                    let waker = cx.waker().clone();
                    match iter.wake(Box::new(move || waker.wake_by_ref())) {
                        WakeResult::Successful => {
                            // Register-then-recheck: a `push` between our last
                            // `next()` (empty) and `wake()` already fired the
                            // still-empty registry and will not re-fire. Catch it
                            // here; park only if still non-target.
                            match iter.next() {
                                Some(Stream::Next(v)) => {
                                    let remaining = this.inner.take().expect("inner should exist");
                                    return Poll::Ready(Some((v, remaining)));
                                }
                                Some(Stream::Ignore) => {}
                                Some(Stream::Spread(items)) => {
                                    for item in items {
                                        if let StreamSpread::Done(v) = item {
                                            let remaining =
                                                this.inner.take().expect("inner should exist");
                                            return Poll::Ready(Some((v, remaining)));
                                        }
                                    }
                                }
                                Some(
                                    Stream::Pending(_)
                                    | Stream::Delayed(_)
                                    | Stream::Init
                                    | Stream::Wait,
                                ) => return Poll::Pending,
                                None => return Poll::Ready(None),
                            }
                        }
                        WakeResult::NotSupported => {
                            cx.waker().wake_by_ref();
                            return Poll::Pending;
                        }
                    }
                }
                Some(Stream::Spread(items)) => {
                    for item in items {
                        if let StreamSpread::Done(v) = item {
                            let remaining = this.inner.take().expect("inner should exist");
                            return Poll::Ready(Some((v, remaining)));
                        }
                    }
                }
                None => return Poll::Ready(None),
            }
        }
    }
}

// ============================================================================
// StreamPendingFuture
// ============================================================================

/// Drives a [`StreamIterator`] until the first `Pending(P)`, returning the context and remaining iterator.
pub struct StreamPendingFuture<SI: StreamIterator> {
    inner: Option<SI>,
}

impl<SI: StreamIterator> StreamPendingFuture<SI> {
    pub fn new(iter: SI) -> Self {
        Self { inner: Some(iter) }
    }
}

impl<SI> Future for StreamPendingFuture<SI>
where
    SI: WakeableStream + Unpin,
{
    type Output = Option<(SI::P, SI)>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let this = self.get_mut();
        let iter = this.inner.as_mut().expect("polled after completion");

        loop {
            match iter.next() {
                Some(Stream::Pending(p)) => {
                    let remaining = this.inner.take().expect("inner should exist");
                    return Poll::Ready(Some((p, remaining)));
                }
                Some(Stream::Ignore) => {}
                Some(Stream::Next(_) | Stream::Delayed(_) | Stream::Init | Stream::Wait) => {
                    let waker = cx.waker().clone();
                    match iter.wake(Box::new(move || waker.wake_by_ref())) {
                        WakeResult::Successful => {
                            // Register-then-recheck: a `push` between our last
                            // `next()` (empty) and `wake()` already fired the
                            // still-empty registry and will not re-fire. Catch it
                            // here; park only if still non-target.
                            match iter.next() {
                                Some(Stream::Pending(p)) => {
                                    let remaining = this.inner.take().expect("inner should exist");
                                    return Poll::Ready(Some((p, remaining)));
                                }
                                Some(Stream::Ignore) => {}
                                Some(Stream::Spread(items)) => {
                                    for item in items {
                                        if let StreamSpread::Pending(p) = item {
                                            let remaining =
                                                this.inner.take().expect("inner should exist");
                                            return Poll::Ready(Some((p, remaining)));
                                        }
                                    }
                                }
                                Some(
                                    Stream::Next(_)
                                    | Stream::Delayed(_)
                                    | Stream::Init
                                    | Stream::Wait,
                                ) => return Poll::Pending,
                                None => return Poll::Ready(None),
                            }
                        }
                        WakeResult::NotSupported => {
                            cx.waker().wake_by_ref();
                            return Poll::Pending;
                        }
                    }
                }
                Some(Stream::Spread(items)) => {
                    for item in items {
                        if let StreamSpread::Pending(p) = item {
                            let remaining = this.inner.take().expect("inner should exist");
                            return Poll::Ready(Some((p, remaining)));
                        }
                    }
                }
                None => return Poll::Ready(None),
            }
        }
    }
}

// ============================================================================
// StreamAsFutureStream
// ============================================================================

/// Wraps a [`StreamIterator`] as a `futures_core::Stream`, yielding each `Stream<D, P>` item as-is.
pub struct StreamAsFutureStream<SI: StreamIterator> {
    inner: Option<SI>,
}

impl<SI: StreamIterator> StreamAsFutureStream<SI> {
    pub fn new(iter: SI) -> Self {
        Self { inner: Some(iter) }
    }
}

impl<SI> FuturesStream for StreamAsFutureStream<SI>
where
    SI: StreamIterator + Unpin,
{
    type Item = Stream<SI::D, SI::P>;

    fn poll_next(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let this = self.get_mut();
        let iter = this.inner.as_mut().expect("polled after completion");
        Poll::Ready(iter.next())
    }
}

// ============================================================================
// StreamNextStream
// ============================================================================

/// WHY: `into_ready_future()` yields one value plus the remaining iterator, which
/// is ceremonial for consuming a body chunk-by-chunk (re-wrap loop). `into_future_stream()`
/// is a raw lens that yields `Stream<D, P>` items as-is (including `Wait`) and never
/// returns `Poll::Pending`, so it cannot serve as an awaitable value stream. This
/// adapter fills the gap (F45 Resolution 5).
///
/// WHAT: A [`futures_core::Stream`] whose `Item` is `SI::D` — it surfaces `Next(v)`
/// (and `Spread` `Done(v)`) payloads, drives past in-band control states, and ends
/// on iterator exhaustion, enabling `while let Some(chunk) = body.next().await`.
///
/// HOW: On `Next(v)` returns `Ready(Some(v))`; on `Spread` buffers every `Done`
/// payload and drains them one per poll; on `Wait`/`Pending`/`Delayed`/`Init`
/// registers a wake through [`WakeableStream::wake`] and parks (falling back to
/// a `wake_by_ref()` self-wake when the iterator reports `NotSupported`); on
/// `Ignore` loops; on `None` returns `Ready(None)` permanently.
#[cfg(any(feature = "std", feature = "alloc"))]
pub struct StreamNextStream<SI: StreamIterator> {
    inner: Option<SI>,
    /// `Done` payloads peeled from a single `Spread` item, surfaced one per poll
    /// before pulling more work from the inner iterator.
    spread: Vec<SI::D>,
}

#[cfg(any(feature = "std", feature = "alloc"))]
impl<SI: StreamIterator> StreamNextStream<SI> {
    pub fn new(iter: SI) -> Self {
        Self {
            inner: Some(iter),
            spread: Vec::new(),
        }
    }
}

#[cfg(any(feature = "std", feature = "alloc"))]
impl<SI> FuturesStream for StreamNextStream<SI>
where
    SI: WakeableStream + Unpin,
    SI::D: Unpin,
{
    type Item = SI::D;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let this = self.get_mut();

        // Drain any buffered Spread(Done) payloads first (lossless fan-out).
        if !this.spread.is_empty() {
            return Poll::Ready(Some(this.spread.remove(0)));
        }

        let iter = match this.inner.as_mut() {
            Some(iter) => iter,
            None => return Poll::Ready(None),
        };

        loop {
            match iter.next() {
                Some(Stream::Next(v)) => return Poll::Ready(Some(v)),
                Some(Stream::Ignore) => {}
                Some(Stream::Pending(_) | Stream::Delayed(_) | Stream::Init | Stream::Wait) => {
                    let waker = cx.waker().clone();
                    match iter.wake(Box::new(move || waker.wake_by_ref())) {
                        WakeResult::Successful => {
                            // Register-then-recheck: a `push` between our last
                            // `next()` (empty) and `wake()` already fired the
                            // still-empty registry and will not re-fire. Catch it
                            // here; park only if still non-target.
                            match iter.next() {
                                Some(Stream::Next(v)) => return Poll::Ready(Some(v)),
                                Some(Stream::Ignore) => {}
                                Some(Stream::Spread(items)) => {
                                    for item in items {
                                        if let StreamSpread::Done(v) = item {
                                            this.spread.push(v);
                                        }
                                    }
                                    if !this.spread.is_empty() {
                                        return Poll::Ready(Some(this.spread.remove(0)));
                                    }
                                }
                                Some(
                                    Stream::Pending(_)
                                    | Stream::Delayed(_)
                                    | Stream::Init
                                    | Stream::Wait,
                                ) => return Poll::Pending,
                                None => {
                                    this.inner = None;
                                    return Poll::Ready(None);
                                }
                            }
                        }
                        WakeResult::NotSupported => {
                            cx.waker().wake_by_ref();
                            return Poll::Pending;
                        }
                    }
                }
                Some(Stream::Spread(items)) => {
                    for item in items {
                        if let StreamSpread::Done(v) = item {
                            this.spread.push(v);
                        }
                    }
                    if !this.spread.is_empty() {
                        return Poll::Ready(Some(this.spread.remove(0)));
                    }
                    // Spread carried no Done payloads; keep polling.
                }
                None => {
                    this.inner = None;
                    return Poll::Ready(None);
                }
            }
        }
    }
}