Expand description
Progress as part of a method’s return type.
A method that reports progress says so in its signature: its item is
Progress<T, P> — impl Stream<Item = Result<Progress<T, P>, E>>, or
impl Stream<Item = Progress<T, P>> when it cannot fail. Progress sits
inside the Result because it is on the success path: an err is never
“in progress”.
Progress is never serialized as a whole. The server sends the two
cases in different frames — Progress::Update as a progress frame
carrying P, Progress::Item as a data frame carrying T — and a
client that opts in sees them again as a Frame.
Structs§
- Note
- The default progress type: a human-readable message and, optionally, how far along the work is.
Enums§
- Progress
- One step of a method that reports progress: an intermediate report on the way to its items, or one of the items.