qubit-fs 0.2.2

Provider-neutral synchronous and asynchronous filesystem abstraction for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
// facade tests.
//! Synchronous aggregate write operation implementation.

use qubit_io::Output;

use crate::FileSystem;
use crate::error::FsError;
use crate::error::FsOperation;
use crate::error::OpenFailureStage;
use crate::metadata::WriteOutcome;
use crate::path::Path;
use crate::write::WriteAllFailure;
use crate::write::WriteFailureState;
use crate::write::WriteOptions;
use crate::write::WriterRecovery;
use crate::write::internal::open_failure_state;

/// Executes aggregate synchronous write operations for one facade.
pub(crate) struct WriteOperation<'a> {
    /// Facade that opens and contextualizes the writer.
    filesystem: &'a FileSystem,
}

impl<'a> WriteOperation<'a> {
    /// Creates a write operation bound to `filesystem`.
    #[inline]
    pub(crate) const fn new(filesystem: &'a FileSystem) -> Self {
        Self { filesystem }
    }

    /// Writes all bytes and retains the writer if transfer or commit fails.
    pub(crate) fn write_all(
        &self,
        path: &Path,
        bytes: &[u8],
        options: WriteOptions,
    ) -> Result<WriteOutcome, WriteAllFailure> {
        if let Err(error) = self
            .filesystem
            .properties()
            .limits()
            .validate_write_size(path, bytes.len())
        {
            return Err(WriteAllFailure::new(
                self.filesystem.core().enrich(error, Some(path), FsOperation::Write),
                WriteFailureState::NotPublished,
                0,
                None,
            ));
        }
        let mut writer = self.filesystem.open_writer(path, options).map_err(|failure| {
            let (error, stage, recovery) = failure.into_parts();
            let state = match stage {
                OpenFailureStage::Preflight => WriteFailureState::NotPublished,
                OpenFailureStage::ProviderOpen => open_failure_state(&error),
                OpenFailureStage::OutcomeValidation => WriteFailureState::Indeterminate,
            };
            WriteAllFailure::new(error, state, 0, recovery.map(WriterRecovery::Rejected))
        })?;
        if let Err(error) = Output::write_fully(&mut writer, bytes).and_then(|_| Output::flush(&mut writer)) {
            let error = FsError::from_stream_io(error, FsOperation::Write, path)
                .with_provider(self.filesystem.properties().info().provider_id());
            let state = if error.has_indeterminate_effect() {
                WriteFailureState::Indeterminate
            } else {
                writer.state().publication_failure_state()
            };
            return Err(WriteAllFailure::new(
                error,
                state,
                writer.written_bytes(),
                Some(WriterRecovery::Opened(Box::new(writer))),
            ));
        }
        writer.commit().map_err(|failure| {
            let (error, state) = failure.into_parts();
            WriteAllFailure::new(
                error,
                state,
                writer.written_bytes(),
                Some(WriterRecovery::Opened(Box::new(writer))),
            )
        })
    }
}