Skip to main content

harmos_storage/
file_capture.rs

1/* ***
2 *
3 * Harmos
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * ***
8 */
9
10// Capture A File Range Into Independent Immutable Durable Storage.
11
12/* === Modules === */
13
14/* === Re-Exports === */
15
16/* === Imports === */
17
18// Standard Library Imports
19
20// Third Party Imports
21
22// Local Imports
23use crate::FileRead;
24use crate::{FileReference, Result, StorageManager};
25use harmos_domain::model::storage::files::CaptureConsistency;
26
27/* === Constants === */
28
29/* === Macros === */
30
31/* === Type Aliases === */
32
33/* === Structs === */
34
35#[derive(Clone, Debug)]
36pub struct FileCapture {
37    pub source: crate::FileSource,
38    pub range: crate::ByteRange,
39    pub metadata: crate::FileMetadata,
40    pub consistency: CaptureConsistency,
41}
42
43/* === Enums === */
44
45/* === Traits === */
46
47/* === Implementations === */
48
49impl<C> StorageManager<C> {
50    pub async fn capture_file(&self, request: FileCapture) -> Result<FileReference> {
51        let context = crate::execution::Context::current();
52        let span = context.sync(|| tracing::debug_span!("storage.file.capture_file", outcome = "cancelled"));
53        context
54            .result(span, async {
55                let mut reader = self
56                    .read_file(FileRead {
57                        source: request.source,
58                        range: request.range,
59                    })
60                    .await?;
61                let mut target = self.create_file(request.metadata).await?;
62                while let Some(batch) = reader.next_raw(false).await? {
63                    let chunk = crate::FileChunk::new(batch.bytes);
64                    let offset = target.length();
65                    target.write_retained_at(offset, chunk).await?;
66                }
67                reader.completion()?;
68                if request.consistency == CaptureConsistency::Stable {
69                    reader.check_unchanged().await?;
70                }
71                let reference = target.finish().await?;
72                self.flush_until(&reference.position).await?;
73                Ok(reference)
74            })
75            .await
76    }
77}
78
79/* === Public Functions === */
80
81/* === Private Functions === */
82
83/* === Tests === */