Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions timely/src/dataflow/operators/generic/handles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ use crate::container::{CapacityContainerBuilder, PushInto};
use crate::dataflow::operators::InputCapability;
use crate::dataflow::operators::capability::CapabilityTrait;

/// An input wrapper type that exists to provide a `must_use` decoration.
///
/// This type is consumed by its methods `for_each` and `for_each_time`, either of which should be called on it.
/// Failure to call either of these methods is very likely a logical error, as it means that input data may linger
/// indefinitely, as the system will not re-invoke the operator until there is additional input data (or another reason).
#[must_use]
pub struct InputSession<'a, T: Timestamp, C, P: Pull<Message<T, C>>> {
input: &'a mut InputHandleCore<T, C, P>,
Expand Down
2 changes: 1 addition & 1 deletion timely/src/dataflow/operators/generic/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ mod handles;
mod notificator;
mod operator_info;

pub use self::handles::{InputHandleCore, OutputBuilder, OutputBuilderSession, Session};
pub use self::handles::{InputHandleCore, InputSession, OutputBuilder, OutputBuilderSession, Session};
pub use self::notificator::{Notificator, FrontierNotificator};

pub use self::operator::{Operator, source};
Expand Down
Loading