Hopiu/lychee
1
0
Fork 0
mirror of https://github.com/Hopiu/lychee.git synced 2026-05-03 11:24:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add more comments to path methods (#543)

Browse source
This commit is contained in:
Matthias 2022-03-08 13:50:54 +01:00 committed by GitHub
parent 5aec733355
commit ceb185e579
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
lychee-lib/src/helpers/path.rs
View file

@ -8,14 +8,16 @@ use std::path::{Path, PathBuf};
static CURRENT_DIR: Lazy<PathBuf> =
Lazy::new(|| env::current_dir().expect("cannot get current dir from environment"));
// Returns the base if it is a valid `PathBuf`
/// Returns the base if it is a valid `PathBuf`
fn get_base_dir(base: &Option<Base>) -> Option<PathBuf> {
base.as_ref().and_then(Base::dir)
}
// The `clean` method is relatively expensive
// Therefore we cache this call to reduce allocs and wall time
// https://stackoverflow.com/a/54817755/270334
/// Create an absolute path out of a `PathBuf`.
///
/// The `clean` method is relatively expensive
/// Therefore we cache this call to reduce allocs and wall time
/// https://stackoverflow.com/a/54817755/270334
#[cached]
pub(crate) fn absolute_path(path: PathBuf) -> PathBuf {
if path.is_absolute() {
@ -26,7 +28,7 @@ pub(crate) fn absolute_path(path: PathBuf) -> PathBuf {
.clean()
}
// Get the directory name of a given `Path`.
/// Get the directory name of a given `Path`.
fn dirname(src: &'_ Path) -> Option<&'_ Path> {
if src.is_file() {
return src.parent();
@ -34,8 +36,8 @@ fn dirname(src: &'_ Path) -> Option<&'_ Path> {
Some(src)
}
// Resolve `dst` that was linked to from within `src`
// Returns Ok(None) in case of an absolute local link without a `base_url`
/// Resolve `dst` that was linked to from within `src`
/// Returns Ok(None) in case of an absolute local link without a `base_url`
pub(crate) fn resolve(src: &Path, dst: &Path, base: &Option<Base>) -> Result<Option<PathBuf>> {
let resolved = match dst {
relative if dst.is_relative() => {
@ -48,7 +50,7 @@ pub(crate) fn resolve(src: &Path, dst: &Path, base: &Option<Base>) -> Result<Opt
}
absolute if dst.is_absolute() => {
// Absolute local links (leading slash) require the `base_url` to
// define the document root. Silently ignore the link in case we
// define the document root. Silently ignore the link in case the
// `base_url` is not defined.
let base = match get_base_dir(base) {
Some(path) => path,