1// Copyright 2022 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
45use anyhow::{Context, Result};
6use std::path::{Path, PathBuf};
78/// Extension trait for getting a String from a Path.
9pub trait PathToStringExt {
10/// Convert the path to a string if it is valid UTF-8, and return an error otherwise.
11fn path_to_string(&self) -> Result<String>;
12}
1314impl PathToStringExt for Path {
15fn path_to_string(&self) -> Result<String> {
16self.to_str()
17 .context(format!("Path is not valid UTF-8: {}", self.display()))
18 .map(str::to_string)
19 }
20}
2122impl PathToStringExt for PathBuf {
23fn path_to_string(&self) -> Result<String> {
24self.to_str()
25 .context(format!("Path is not valid UTF-8: {}", self.display()))
26 .map(str::to_string)
27 }
28}
2930#[cfg(test)]
31mod tests {
32use super::PathToStringExt;
33use std::ffi::OsString;
34use std::os::unix::ffi::OsStringExt;
35use std::path::PathBuf;
3637#[test]
38fn path_to_string() {
39let path = PathBuf::from("/some/path/to/file.txt");
40let string = path.path_to_string().unwrap();
41assert_eq!(string, "/some/path/to/file.txt".to_string());
42 }
4344#[test]
45fn invalid_path_to_string() {
46let invalid_path = PathBuf::from(OsString::from_vec(b"invalid\xe7".to_vec()));
47assert!(invalid_path.path_to_string().is_err());
48 }
49}