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

//! Functions for working with [`xattr`] crate.
//!
//! [`xattr`]: https://crates.io/crates/xattr

use crate::{asyncify, XAttrs};
use blocking_xattr;

use std::ffi::OsStr;
use std::io;
use std::path::Path;

/// Get an extended attribute for the specified file.
///
/// # Examples
///
/// ```no_run
/// # async fn dox() -> std::io::Result<()> {
/// let val = tokio_xattr::get(".", "user.myattr1").await?;
/// # Ok(())
/// # }
/// ```
pub async fn get<P, N>(path: P, name: N) -> io::Result<Option<Vec<u8>>>
where
    P: AsRef<Path>,
    N: AsRef<OsStr>,
{
    let path = path.as_ref().to_owned();
    let name = name.as_ref().to_owned();
    asyncify(move || Ok(blocking_xattr::get(&path, &name)?)).await
}

/// List extended attributes attached to the specified file.
///
/// # Examples
///
/// ```no_run
/// # async fn dox() -> std::io::Result<()> {
/// let xattrs = tokio_xattr::list(".").await?;
/// for attr in xattrs {
///     println!("attr_name={:?}", attr);
/// }
/// # Ok(())
/// # }
/// ```
pub async fn list<P>(path: P) -> io::Result<XAttrs>
where
    P: AsRef<Path>,
{
    let path = path.as_ref().to_owned();
    asyncify(move || Ok(blocking_xattr::list(&path)?)).await
}

/// Remove an extended attribute from the specified file.
///
/// # Examples
///
/// ```no_run
/// # async fn dox() -> std::io::Result<()> {
/// tokio_xattr::remove(".", "user.myattr1").await?;
/// # Ok(())
/// # }
/// ```
pub async fn remove<P, N>(path: P, name: N) -> io::Result<()>
where
    P: AsRef<Path>,
    N: AsRef<OsStr>,
{
    let path = path.as_ref().to_owned();
    let name = name.as_ref().to_owned();
    asyncify(move || Ok(blocking_xattr::remove(&path, &name)?)).await
}

/// Set an extended attribute on the specified file.
///
/// # Examples
///
/// ```no_run
/// # async fn dox() -> std::io::Result<()> {
/// tokio_xattr::set(".", "user.myattr1", &[0x12, 0x34, 0x56]).await?;
/// # Ok(())
/// # }
/// ```
pub async fn set<P, N>(path: P, name: N, value: &[u8]) -> io::Result<()>
where
    P: AsRef<Path>,
    N: AsRef<OsStr>,
{
    let path = path.as_ref().to_owned();
    let name = name.as_ref().to_owned();
    let value = value.as_ref().to_owned();
    asyncify(move || Ok(blocking_xattr::set(&path, &name, &value)?)).await
}