Skip to content

Commit

Permalink
obvious stuff from diff
Browse files Browse the repository at this point in the history
Signed-off-by: clux <[email protected]>
  • Loading branch information
clux committed Oct 3, 2024
1 parent 441f06f commit ca47556
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/controllers/streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ But note this changes the stream signature slightly; returning a wrapped [Partia
- **decoded stream** :: a stream that's been through [EventDecode] via one of `WatchStreamExt::touched_objects`, `WatchStreamExt::applied_objects`
- **event stream** :: a raw [watcher] stream producing [watcher::Event] objects

The significant difference between them is that the **user** and the [Controller] generally wants to interact with an **decoded stream**, but a [reflector] needs an **event stream** to be able to safely replace its contents.
The significant difference between them is that the **user** and the [Controller] generally wants to interact with a **decoded stream**, but a [reflector] needs an **event stream** to be able to safely replace its contents.

### WatchStreamExt
The [WatchStreamExt] trait is a `Stream` extension trait (ala [StreamExt]) with Kubernetes specific helper methods that can be chained onto a watcher stream;
Expand Down Expand Up @@ -138,7 +138,7 @@ Controller::for_stream(main_stream, reader)
.watches_stream(watched_custom_stream, cfg)
```

where the various stream variables would be created from either [watcher], or [metadata_watcher] with some filters applied.
where the various stream variables would be created from either [watcher], or [metadata_watcher] with a decoder applied.

!!! warning "The controller streams interface is unstable"

Expand Down

0 comments on commit ca47556

Please sign in to comment.