libdd-capabilities 3.0.1

Portable capability traits for cross-platform libdatadog
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

// Copyright 2026-Present Datadog, Inc. https://www.datadoghq.com/
// SPDX-License-Identifier: Apache-2.0

//! File-system capability trait and error types.
//!
//! Async so a wasm impl can await `fs.promises`. Paths are `&str` because
//! wasm callers hand them across the JS boundary as strings.

use crate::maybe_send::MaybeSend;
use core::future::Future;

#[derive(Debug, thiserror::Error)]
pub enum FileError {
    #[error("File not found: {0}")]
    NotFound(String),
    #[error("Permission denied: {0}")]
    PermissionDenied(String),
    #[error("IO error: {0}")]
    Io(anyhow::Error),
}

/// Snapshot of a file-system entry's metadata.
///
/// `inode` is `None` when the underlying platform does not expose one (Windows
/// via `std`). Node.js exposes an inode on every platform, so the wasm impl
/// always populates it.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FileMetadata {
    pub size: u64,
    pub inode: Option<u64>,
    pub is_file: bool,
    pub is_dir: bool,
}

pub trait FileCapability: Clone + std::fmt::Debug {
    fn new() -> Self;

    fn read(&self, path: &str)
        -> impl Future<Output = Result<bytes::Bytes, FileError>> + MaybeSend;

    fn write(
        &self,
        path: &str,
        contents: bytes::Bytes,
    ) -> impl Future<Output = Result<(), FileError>> + MaybeSend;

    fn metadata(
        &self,
        path: &str,
    ) -> impl Future<Output = Result<FileMetadata, FileError>> + MaybeSend;

    fn exists(&self, path: &str) -> impl Future<Output = Result<bool, FileError>> + MaybeSend;
}