runtime: rename references from Flatten to Filter where necessary #1520
Conversation
closes #1517 Signed-off-by: clux <[email protected]>
Signed-off-by: clux <[email protected]>
Signed-off-by: clux <[email protected]>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1520 +/- ##
=====================================
Coverage 75.7% 75.7%
=====================================
Files 79 79
Lines 7252 7252
=====================================
Hits 5487 5487
Misses 1765 1765
|
Signed-off-by: clux <[email protected]>
| @@ -9,17 +9,17 @@ use pin_project::pin_project; | |||
| #[pin_project] | |||
| /// Stream returned by the [`applied_objects`](super::WatchStreamExt::applied_objects) and [`touched_objects`](super::WatchStreamExt::touched_objects) method. | |||
| #[must_use = "streams do nothing unless polled"] | |||
| pub struct EventFlatten<St> { | |||
| pub struct EventFilter<St> { | |||
There was a problem hiding this comment.
nitpicky thought: EventFilter sounds like a good name imo, especially given its use now. I wonder thought if it makes sense to me because I've seen it before. Would users conflate it with PredicateFilter (although, being my own's devil advocate, that's what docs are for).
Would a name like EventDecode work better to convey that what we are actually doing is just taking the inner value?
There was a problem hiding this comment.
hm, yeah... possibly. maybe i'll hang on to this PR for a little bit first to see if it clashes with use cases for stream forwarding (since it was also running into the same issues.
Co-authored-by: Matei David <[email protected]> Signed-off-by: Eirik A <[email protected]>
Signed-off-by: Eirik A <[email protected]>
closes #1517 - we no longer flatten anything.
creates a deprecated type alias for
EventFlattenin its place because is actually exposed. Users ofWatchStreamExtdirect will not notice / care for this, but would be nice if direct users - if they exist - get a warning.docs updated in kube-rs/website#66