Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-04 18:19:13 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix(clap_lex): Deprecate unsound OsStrExt::split_at

Browse source
This commit is contained in:
Ed Page 2023-03-27 23:32:30 -05:00
parent 56dc953617
commit 48dc66f652
2 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
clap_lex/src/ext.rs
View file

@ -193,6 +193,7 @@ pub trait OsStrExt: private::Sealed {
/// assert_eq!("Per", first);
/// assert_eq!(" Martin-Löf", last);
/// ```
#[deprecated(since = "4.1.0", note = "This is not sound for all `index`")]
fn split_at(&self, index: usize) -> (&OsStr, &OsStr);
/// Splits the string on the first occurrence of the specified delimiter and
/// returns prefix before delimiter and suffix after delimiter.
@ -251,7 +252,7 @@ impl OsStrExt for OsStr {
}
fn split_at(&self, index: usize) -> (&OsStr, &OsStr) {
// BUG: This is unsafe
// BUG: This is unsafe and has been deprecated
unsafe {
let bytes = to_bytes(self);
let (first, second) = bytes.split_at(index);
@ -294,7 +295,7 @@ unsafe fn to_bytes(s: &OsStr) -> &[u8] {
//
// There is a proposal to support this natively (https://github.com/rust-lang/rust/pull/95290)
// but its in limbo
unsafe { std::mem::transmute(s) }
std::mem::transmute(s)
}
/// Restore raw bytes as `OsStr`
@ -313,7 +314,7 @@ unsafe fn to_os_str(s: &[u8]) -> &OsStr {
//
// There is a proposal to support this natively (https://github.com/rust-lang/rust/pull/95290)
// but its in limbo
unsafe { std::mem::transmute(s) }
std::mem::transmute(s)
}
pub struct Split<'s, 'n> {
@ -341,3 +342,14 @@ impl<'s, 'n> Iterator for Split<'s, 'n> {
}
}
}
/// Split an `OsStr`
///
/// # Safety
///
/// `index` must be at a valid UTF-8 boundary
pub(crate) unsafe fn split_at(os: &OsStr, index: usize) -> (&OsStr, &OsStr) {
let bytes = to_bytes(os);
let (first, second) = bytes.split_at(index);
(to_os_str(first), to_os_str(second))
}

7
clap_lex/src/lib.rs
View file

@ -433,7 +433,9 @@ impl<'s> ShortFlags<'s> {
if let Some((index, _)) = self.utf8_prefix.next() {
self.utf8_prefix = "".char_indices();
self.invalid_suffix = None;
return Some(self.inner.split_at(index).1);
// SAFETY: `char_indices` ensures `index` is at a valid UTF-8 boundary
let remainder = unsafe { ext::split_at(self.inner, index).1 };
return Some(remainder);
}
if let Some(suffix) = self.invalid_suffix {
@ -457,7 +459,8 @@ fn split_nonutf8_once(b: &OsStr) -> (&str, Option<&OsStr>) {
match b.try_str() {
Ok(s) => (s, None),
Err(err) => {
let (valid, after_valid) = b.split_at(err.valid_up_to());
// SAFETY: `char_indices` ensures `index` is at a valid UTF-8 boundary
let (valid, after_valid) = unsafe { ext::split_at(b, err.valid_up_to()) };
let valid = valid.try_str().unwrap();
(valid, Some(after_valid))
}