( )⚙ D10007 rust: Introduce a get_bytes_from_os_str utility function

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10007

rust: Introduce a get_bytes_from_os_str utility function
ClosedPublic

Authored by SimonSapin on Feb 17 2021, 7:58 AM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHGd2e61f00ee9d: rust: Introduce a get_bytes_from_os_str utility function
rHGec54e04c5f04: rust: Introduce a get_bytes_from_os_str utility function
Summary

It does the same as get_bytes_from_path but takes an OsStr
instead of a Path. The implementation is the same so using either
ends up correct but the function name suggests it’s not.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Revision Contents
Changeset List

Diff 25644

rust/hg-core/src/config/config.rs

// config.rs // config.rs
// //
// Copyright 2020 // Copyright 2020
// Valentin Gatien-Baron, // Valentin Gatien-Baron,
// Raphaël Gomès <rgomes@octobus.net> // Raphaël Gomès <rgomes@octobus.net>
// //
// This software may be used and distributed according to the terms of the // This software may be used and distributed according to the terms of the
// GNU General Public License version 2 or any later version. // GNU General Public License version 2 or any later version.
use super::layer; use super::layer;
use crate::config::layer::{ use crate::config::layer::{
ConfigError, ConfigLayer, ConfigParseError, ConfigValue, ConfigError, ConfigLayer, ConfigParseError, ConfigValue,
}; };
use crate::utils::files::get_bytes_from_path; use crate::utils::files::get_bytes_from_os_str;
use format_bytes::{write_bytes, DisplayBytes}; use format_bytes::{write_bytes, DisplayBytes};
use std::env; use std::env;
use std::path::{Path, PathBuf}; use std::path::{Path, PathBuf};
use crate::errors::{HgResultExt, IoResultExt}; use crate::errors::{HgResultExt, IoResultExt};
/// Holds the config values for the current repository /// Holds the config values for the current repository
/// TODO update this docstring once we support more sources /// TODO update this docstring once we support more sources
key: &[u8], key: &[u8],
) { ) {
if let Some(value) = env::var_os(var) { if let Some(value) = env::var_os(var) {
let origin = layer::ConfigOrigin::Environment(var.into()); let origin = layer::ConfigOrigin::Environment(var.into());
let mut layer = ConfigLayer::new(origin); let mut layer = ConfigLayer::new(origin);
layer.add( layer.add(
section.to_owned(), section.to_owned(),
key.to_owned(), key.to_owned(),
// `value` is not a path but this works for any `OsStr`: get_bytes_from_os_str(value),
get_bytes_from_path(value),
None, None,
); );
self.layers.push(layer) self.layers.push(layer)
} }
} }
#[cfg(unix)] // TODO: other platforms #[cfg(unix)] // TODO: other platforms
fn add_system_config(&mut self) -> Result<(), ConfigError> { fn add_system_config(&mut self) -> Result<(), ConfigError> {

rust/hg-core/src/utils/files.rs

use crate::utils::{ use crate::utils::{
hg_path::{path_to_hg_path_buf, HgPath, HgPathBuf, HgPathError}, hg_path::{path_to_hg_path_buf, HgPath, HgPathBuf, HgPathError},
path_auditor::PathAuditor, path_auditor::PathAuditor,
replace_slice, replace_slice,
}; };
use lazy_static::lazy_static; use lazy_static::lazy_static;
use same_file::is_same_file; use same_file::is_same_file;
use std::borrow::{Cow, ToOwned}; use std::borrow::{Cow, ToOwned};
use std::ffi::OsStr;
use std::fs::Metadata; use std::fs::Metadata;
use std::iter::FusedIterator; use std::iter::FusedIterator;
use std::ops::Deref; use std::ops::Deref;
use std::path::{Path, PathBuf}; use std::path::{Path, PathBuf};
pub fn get_path_from_bytes(bytes: &[u8]) -> &Path { pub fn get_path_from_bytes(bytes: &[u8]) -> &Path {
let os_str; let os_str;
#[cfg(unix)] #[cfg(unix)]
{ {
use std::os::unix::ffi::OsStrExt; use std::os::unix::ffi::OsStrExt;
os_str = std::ffi::OsStr::from_bytes(bytes); os_str = std::ffi::OsStr::from_bytes(bytes);
} }
// TODO Handle other platforms // TODO Handle other platforms
// TODO: convert from WTF8 to Windows MBCS (ANSI encoding). // TODO: convert from WTF8 to Windows MBCS (ANSI encoding).
// Perhaps, the return type would have to be Result<PathBuf>. // Perhaps, the return type would have to be Result<PathBuf>.
Path::new(os_str) Path::new(os_str)
} }
// TODO: need to convert from WTF8 to MBCS bytes on Windows. // TODO: need to convert from WTF8 to MBCS bytes on Windows.
// that's why Vec<u8> is returned. // that's why Vec<u8> is returned.
#[cfg(unix)] #[cfg(unix)]
pub fn get_bytes_from_path(path: impl AsRef<Path>) -> Vec<u8> { pub fn get_bytes_from_path(path: impl AsRef<Path>) -> Vec<u8> {
get_bytes_from_os_str(path.as_ref())
}
#[cfg(unix)]
pub fn get_bytes_from_os_str(str: impl AsRef<OsStr>) -> Vec<u8> {
use std::os::unix::ffi::OsStrExt; use std::os::unix::ffi::OsStrExt;
path.as_ref().as_os_str().as_bytes().to_vec() str.as_ref().as_bytes().to_vec()
} }
/// An iterator over repository path yielding itself and its ancestors. /// An iterator over repository path yielding itself and its ancestors.
#[derive(Copy, Clone, Debug)] #[derive(Copy, Clone, Debug)]
pub struct Ancestors<'a> { pub struct Ancestors<'a> {
next: Option<&'a HgPath>, next: Option<&'a HgPath>,
} }

rust/rhg/src/main.rs

// possibly-iterator of all values. // possibly-iterator of all values.
let values_of_global_arg = |name: &str| { let values_of_global_arg = |name: &str| {
let a = matches.values_of_os(name).into_iter().flatten(); let a = matches.values_of_os(name).into_iter().flatten();
let b = subcommand_args.values_of_os(name).into_iter().flatten(); let b = subcommand_args.values_of_os(name).into_iter().flatten();
a.chain(b) a.chain(b)
}; };
let config_args = values_of_global_arg("config") let config_args = values_of_global_arg("config")
// `get_bytes_from_path` works for OsStr the same as for Path .map(hg::utils::files::get_bytes_from_os_str);
.map(hg::utils::files::get_bytes_from_path);
let non_repo_config = &hg::config::Config::load(config_args)?; let non_repo_config = &hg::config::Config::load(config_args)?;
let repo_path = value_of_global_arg("repository").map(Path::new); let repo_path = value_of_global_arg("repository").map(Path::new);
let repo = match Repo::find(non_repo_config, repo_path) { let repo = match Repo::find(non_repo_config, repo_path) {
Ok(repo) => Ok(repo), Ok(repo) => Ok(repo),
Err(RepoError::NotFound { at }) if repo_path.is_none() => { Err(RepoError::NotFound { at }) if repo_path.is_none() => {
// Not finding a repo is not fatal yet, if `-R` was not given // Not finding a repo is not fatal yet, if `-R` was not given
Err(NoRepoInCwdError { cwd: at }) Err(NoRepoInCwdError { cwd: at })