Skip to main content

qubit_fs/read/
checksum_policy.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//! Checksum policy for read operations.
9
10/// Checksum behavior requested by a read operation.
11///
12/// # Examples
13///
14/// ```rust
15/// use qubit_fs::read::ChecksumPolicy;
16///
17/// assert_eq!(ChecksumPolicy::None, ChecksumPolicy::default());
18/// ```
19#[derive(Clone, Copy, Debug, Eq, PartialEq)]
20pub enum ChecksumPolicy {
21    /// Do not require checksum validation.
22    None,
23    /// Validate checksums when the provider can do so cheaply.
24    BestEffort,
25    /// Require checksum validation or fail.
26    Required,
27}
28
29impl Default for ChecksumPolicy {
30    /// Does not require checksum validation by default.
31    #[inline]
32    fn default() -> Self {
33        Self::None
34    }
35}