khive-fold 0.2.3

//! Fold outcome type

/// Outcome of a fold operation.
///
/// Deterministic: contains only derived state and entry count. No wall-clock timing.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct FoldOutcome<S> {
    /// The derived state.
    pub state: S,

    /// Number of entries processed.
    pub entries_processed: usize,
}

impl<S> FoldOutcome<S> {
    /// Create a new fold outcome.
    pub fn new(state: S, entries_processed: usize) -> Self {
        Self {
            state,
            entries_processed,
        }
    }

    /// Map the state to a different type.
    pub fn map<T, F: FnOnce(S) -> T>(self, f: F) -> FoldOutcome<T> {
        FoldOutcome::new(f(self.state), self.entries_processed)
    }
}

impl<S: Default> Default for FoldOutcome<S> {
    fn default() -> Self {
        Self::new(S::default(), 0)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_fold_outcome_creation() {
        let result = FoldOutcome::new(42, 10);
        assert_eq!(result.state, 42);
        assert_eq!(result.entries_processed, 10);
    }

    #[test]
    fn test_fold_outcome_map() {
        let result = FoldOutcome::new(42, 10);
        let mapped = result.map(|x| x.to_string());
        assert_eq!(mapped.state, "42");
        assert_eq!(mapped.entries_processed, 10);
    }

    #[test]
    fn deterministic_no_timing_fields() {
        let a = FoldOutcome::new(7usize, 3);
        let b = FoldOutcome::new(7usize, 3);
        assert_eq!(a, b);
    }

    #[test]
    fn default_is_zero_state_zero_count() {
        let d = FoldOutcome::<usize>::default();
        assert_eq!(d.state, 0);
        assert_eq!(d.entries_processed, 0);
    }
}