Skip to main content

qubit_fs/write/
write_abort_outcome.rs

1// =============================================================================
2//    Copyright (c) 2026 Haixing Hu.
3//
4//    SPDX-License-Identifier: Apache-2.0
5//
6//    Licensed under the Apache License, Version 2.0.
7// =============================================================================
8//! Publication certainty after writer cancellation.
9
10/// Provider-confirmed destination state after writer cleanup completes.
11///
12/// # Examples
13///
14/// ```rust
15/// use qubit_fs::write::WriteAbortOutcome;
16///
17/// assert!(matches!(WriteAbortOutcome::NotPublished, WriteAbortOutcome::NotPublished));
18/// ```
19#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
20#[must_use]
21pub enum WriteAbortOutcome {
22    /// Cleanup completed and the destination was proven unchanged.
23    NotPublished,
24    /// Cleanup completed after the destination had already changed.
25    Published,
26    /// Cleanup completed, but the destination state remains unknown.
27    Indeterminate,
28}