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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
use std::ffi::CStr;
use std::time::{Duration, SystemTime, UNIX_EPOCH};
use hdfs_sys::*;
/// Metadata of a path.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Metadata {
/// the name of the file, like `file:/path/to/file`
path: String,
/// the size of the file in bytes
size: i64,
/// file or directory
kind: u32,
/// the permissions associated with the file
permissions: i16,
/// the count of replicas
replication: i16,
/// the block size for the file
block_size: i64,
/// the owner of the file
owner: String,
/// the group associated with the file
group: String,
/// the last modification time for the file in seconds
last_mod: i64,
/// the last access time for the file in seconds
last_access: i64,
}
impl Metadata {
/// the path of the file, like `/path/to/file`
///
/// # Notes
///
/// Hadoop has [restrictions](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/filesystem/introduction.html) of path name:
///
/// - A Path is comprised of Path elements separated by "/".
/// - A path element is a unicode string of 1 or more characters.
/// - Path element MUST NOT include the characters ":" or "/".
/// - Path element SHOULD NOT include characters of ASCII/UTF-8 value 0-31 .
/// - Path element MUST NOT be "." or ".."
/// - Note also that the Azure blob store documents say that paths SHOULD NOT use a trailing "." (as their .NET URI class strips it).
/// - Paths are compared based on unicode code-points.
/// - Case-insensitive and locale-specific comparisons MUST NOT not be used.
pub fn path(&self) -> &str {
&self.path
}
/// the size of the file in bytes
///
/// Metadata is not a collection, so we will not provide `is_empty`.
/// Keep the same style with `std::fs::File`
#[allow(clippy::len_without_is_empty)]
pub fn len(&self) -> u64 {
self.size as u64
}
/// file or directory
pub fn is_dir(&self) -> bool {
self.kind == tObjectKind_kObjectKindDirectory
}
/// file or directory
pub fn is_file(&self) -> bool {
self.kind == tObjectKind_kObjectKindFile
}
/// the permissions associated with the file
pub fn permissions(&self) -> i16 {
self.permissions
}
/// the count of replicas
pub fn replication(&self) -> i16 {
self.replication
}
/// the block size for the file
pub fn block_size(&self) -> i64 {
self.block_size
}
/// the owner of the file
pub fn owner(&self) -> &str {
&self.owner
}
/// the group associated with the file
pub fn group(&self) -> &str {
&self.group
}
/// the last modification time for the file in seconds
pub fn modified(&self) -> SystemTime {
UNIX_EPOCH
.checked_add(Duration::from_secs(self.last_mod as u64))
.expect("must be valid SystemTime")
}
/// the last access time for the file in seconds
pub fn accessed(&self) -> SystemTime {
UNIX_EPOCH
.checked_add(Duration::from_secs(self.last_access as u64))
.expect("must be valid SystemTime")
}
}
impl From<hdfsFileInfo> for Metadata {
fn from(hfi: hdfsFileInfo) -> Self {
Self {
path: {
let p = unsafe {
CStr::from_ptr(hfi.mName)
.to_str()
.expect("hdfs owner must be valid utf-8")
};
match p.find(':') {
None => p.to_string(),
Some(idx) => match &p[..idx] {
// `file:/path/to/file` => `/path/to/file`
"file" => p[idx + 1..].to_string(),
// `hdfs://127.0.0.1:9000/path/to/file` => `/path/to/file`
_ => {
// length of `hdfs://`
let scheme = idx + 2;
// the first occur of `/` in `127.0.0.1:9000/path/to/file`
let endpoint = &p[scheme + 1..]
.find('/')
.expect("hdfs must returns an absolute path");
p[scheme + endpoint + 1..].to_string()
}
},
}
},
size: hfi.mSize,
kind: hfi.mKind,
permissions: hfi.mPermissions,
replication: hfi.mReplication,
block_size: hfi.mBlockSize,
owner: unsafe {
CStr::from_ptr(hfi.mOwner)
.to_str()
.expect("hdfs owner must be valid utf-8")
.into()
},
group: unsafe {
CStr::from_ptr(hfi.mGroup)
.to_str()
.expect("hdfs owner must be valid utf-8")
.into()
},
last_mod: hfi.mLastMod,
last_access: hfi.mLastAccess,
}
}
}
#[cfg(test)]
mod tests {
use std::ffi::CString;
use super::*;
#[test]
fn test_from_hdfs_file_info() -> anyhow::Result<()> {
let cases = vec![
(
hdfsFileInfo {
mKind: 0,
mName: CString::new("file:/path/to/file")?.into_raw(),
mLastMod: 0,
mSize: 123,
mReplication: 0,
mBlockSize: 0,
mOwner: CString::new("xuanwo")?.into_raw(),
mGroup: CString::new("xuanwo")?.into_raw(),
mPermissions: 0,
mLastAccess: 0,
},
Metadata {
path: "/path/to/file".into(),
size: 123,
kind: 0,
permissions: 0,
replication: 0,
block_size: 0,
owner: "xuanwo".into(),
group: "xuanwo".into(),
last_mod: 0,
last_access: 0,
},
),
(
hdfsFileInfo {
mKind: 0,
mName: CString::new("hdfs://127.0.0.1:9000/path/to/file")?.into_raw(),
mLastMod: 455,
mSize: 0,
mReplication: 0,
mBlockSize: 0,
mOwner: CString::new("xuanwo")?.into_raw(),
mGroup: CString::new("xuanwo")?.into_raw(),
mPermissions: 0,
mLastAccess: 0,
},
Metadata {
path: "/path/to/file".into(),
size: 0,
kind: 0,
permissions: 0,
replication: 0,
block_size: 0,
owner: "xuanwo".into(),
group: "xuanwo".into(),
last_mod: 455,
last_access: 0,
},
),
(
hdfsFileInfo {
mKind: 0,
mName: CString::new("/path/to/file")?.into_raw(),
mLastMod: 455,
mSize: 0,
mReplication: 0,
mBlockSize: 0,
mOwner: CString::new("xuanwo")?.into_raw(),
mGroup: CString::new("xuanwo")?.into_raw(),
mPermissions: 0,
mLastAccess: 0,
},
Metadata {
path: "/path/to/file".into(),
size: 0,
kind: 0,
permissions: 0,
replication: 0,
block_size: 0,
owner: "xuanwo".into(),
group: "xuanwo".into(),
last_mod: 455,
last_access: 0,
},
),
];
for case in cases {
let meta = Metadata::from(case.0);
assert_eq!(meta, case.1);
}
Ok(())
}
}