| // Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License.. |
| |
| use crate::untrusted::fs; |
| use crate::io; |
| use crate::path::Path; |
| use crate::path::PathBuf; |
| |
| pub trait PathEx { |
| fn metadata(&self) -> io::Result<fs::Metadata>; |
| fn symlink_metadata(&self) -> io::Result<fs::Metadata>; |
| fn canonicalize(&self) -> io::Result<PathBuf>; |
| fn read_link(&self) -> io::Result<PathBuf>; |
| fn read_dir(&self) -> io::Result<fs::ReadDir>; |
| fn exists(&self) -> bool; |
| fn is_file(&self) -> bool; |
| fn is_dir(&self) -> bool; |
| } |
| |
| impl PathEx for Path { |
| /// Queries the file system to get information about a file, directory, etc. |
| /// |
| /// This function will traverse symbolic links to query information about the |
| /// destination file. |
| /// |
| /// This is an alias to [`fs::metadata`]. |
| /// |
| /// [`fs::metadata`]: ../fs/fn.metadata.html |
| /// |
| fn metadata(&self) -> io::Result<fs::Metadata> { |
| fs::metadata(self) |
| } |
| |
| /// Queries the metadata about a file without following symlinks. |
| /// |
| /// This is an alias to [`fs::symlink_metadata`]. |
| /// |
| /// [`fs::symlink_metadata`]: ../fs/fn.symlink_metadata.html |
| /// |
| fn symlink_metadata(&self) -> io::Result<fs::Metadata> { |
| fs::symlink_metadata(self) |
| } |
| |
| /// Returns the canonical form of the path with all intermediate components |
| /// normalized and symbolic links resolved. |
| /// |
| /// This is an alias to [`fs::canonicalize`]. |
| /// |
| /// [`fs::canonicalize`]: ../fs/fn.canonicalize.html |
| /// |
| fn canonicalize(&self) -> io::Result<PathBuf> { |
| fs::canonicalize(self) |
| } |
| |
| /// Reads a symbolic link, returning the file that the link points to. |
| /// |
| /// This is an alias to [`fs::read_link`]. |
| /// |
| /// [`fs::read_link`]: ../fs/fn.read_link.html |
| /// |
| fn read_link(&self) -> io::Result<PathBuf> { |
| fs::read_link(self) |
| } |
| |
| fn read_dir(&self) -> io::Result<fs::ReadDir> { |
| fs::read_dir(self) |
| } |
| /// Returns whether the path points at an existing entity. |
| /// |
| /// This function will traverse symbolic links to query information about the |
| /// destination file. In case of broken symbolic links this will return `false`. |
| /// |
| /// If you cannot access the directory containing the file, e.g. because of a |
| /// permission error, this will return `false`. |
| /// |
| fn exists(&self) -> bool { |
| fs::metadata(self).is_ok() |
| } |
| |
| /// Returns whether the path exists on disk and is pointing at a regular file. |
| /// |
| /// This function will traverse symbolic links to query information about the |
| /// destination file. In case of broken symbolic links this will return `false`. |
| /// |
| /// If you cannot access the directory containing the file, e.g. because of a |
| /// permission error, this will return `false`. |
| /// |
| fn is_file(&self) -> bool { |
| fs::metadata(self).map(|m| m.is_file()).unwrap_or(false) |
| } |
| |
| /// Returns whether the path exists on disk and is pointing at a directory. |
| /// |
| /// This function will traverse symbolic links to query information about the |
| /// destination file. In case of broken symbolic links this will return `false`. |
| /// |
| /// If you cannot access the directory containing the file, e.g. because of a |
| /// permission error, this will return `false`. |
| /// |
| fn is_dir(&self) -> bool { |
| fs::metadata(self).map(|m| m.is_dir()).unwrap_or(false) |
| } |
| } |