qubit-fs 0.1.0

Pluggable 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

/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! Writer trait for filesystem resources.

use std::io::Write;

use crate::{
    FsResult,
    WriteOutcome,
};

/// Write handle returned by filesystem implementations.
pub trait FileWriter: Write + Send {
    /// Commits the write operation.
    ///
    /// # Returns
    /// Write outcome reported by the provider.
    ///
    /// # Errors
    /// Returns [`crate::FsError`] when the provider cannot commit the write.
    fn commit(self: Box<Self>) -> FsResult<WriteOutcome>;

    /// Aborts the write operation.
    ///
    /// # Errors
    /// Returns [`crate::FsError`] when the provider cannot abort or clean up
    /// the write session.
    fn abort(self: Box<Self>) -> FsResult<()>;
}