diff options
Diffstat (limited to 'vendor/clap_lex/src/ext.rs')
| -rw-r--r-- | vendor/clap_lex/src/ext.rs | 312 |
1 files changed, 0 insertions, 312 deletions
diff --git a/vendor/clap_lex/src/ext.rs b/vendor/clap_lex/src/ext.rs deleted file mode 100644 index a2de707..0000000 --- a/vendor/clap_lex/src/ext.rs +++ /dev/null @@ -1,312 +0,0 @@ -use std::ffi::OsStr; - -pub trait OsStrExt: private::Sealed { - /// Converts to a string slice. - fn try_str(&self) -> Result<&str, std::str::Utf8Error>; - /// Returns `true` if the given pattern matches a sub-slice of - /// this string slice. - /// - /// Returns `false` if it does not. - /// - /// # Examples - /// - /// ```rust - /// use clap_lex::OsStrExt as _; - /// let bananas = std::ffi::OsStr::new("bananas"); - /// - /// assert!(bananas.contains("nana")); - /// assert!(!bananas.contains("apples")); - /// ``` - fn contains(&self, needle: &str) -> bool; - /// Returns the byte index of the first character of this string slice that - /// matches the pattern. - /// - /// Returns [`None`] if the pattern doesn't match. - /// - /// # Examples - /// - /// ```rust - /// use clap_lex::OsStrExt as _; - /// let s = std::ffi::OsStr::new("Löwe 老虎 Léopard Gepardi"); - /// - /// assert_eq!(s.find("L"), Some(0)); - /// assert_eq!(s.find("é"), Some(14)); - /// assert_eq!(s.find("par"), Some(17)); - /// ``` - /// - /// Not finding the pattern: - /// - /// ```rust - /// use clap_lex::OsStrExt as _; - /// let s = std::ffi::OsStr::new("Löwe 老虎 Léopard"); - /// - /// assert_eq!(s.find("1"), None); - /// ``` - fn find(&self, needle: &str) -> Option<usize>; - /// Returns a string slice with the prefix removed. - /// - /// If the string starts with the pattern `prefix`, returns substring after the prefix, wrapped - /// in `Some`. - /// - /// If the string does not start with `prefix`, returns `None`. - /// - /// # Examples - /// - /// ``` - /// use std::ffi::OsStr; - /// use clap_lex::OsStrExt as _; - /// assert_eq!(OsStr::new("foo:bar").strip_prefix("foo:"), Some(OsStr::new("bar"))); - /// assert_eq!(OsStr::new("foo:bar").strip_prefix("bar"), None); - /// assert_eq!(OsStr::new("foofoo").strip_prefix("foo"), Some(OsStr::new("foo"))); - /// ``` - fn strip_prefix(&self, prefix: &str) -> Option<&OsStr>; - /// Returns `true` if the given pattern matches a prefix of this - /// string slice. - /// - /// Returns `false` if it does not. - /// - /// # Examples - /// - /// ``` - /// use clap_lex::OsStrExt as _; - /// let bananas = std::ffi::OsStr::new("bananas"); - /// - /// assert!(bananas.starts_with("bana")); - /// assert!(!bananas.starts_with("nana")); - /// ``` - fn starts_with(&self, prefix: &str) -> bool; - /// An iterator over substrings of this string slice, separated by - /// characters matched by a pattern. - /// - /// # Examples - /// - /// Simple patterns: - /// - /// ``` - /// use std::ffi::OsStr; - /// use clap_lex::OsStrExt as _; - /// let v: Vec<_> = OsStr::new("Mary had a little lamb").split(" ").collect(); - /// assert_eq!(v, [OsStr::new("Mary"), OsStr::new("had"), OsStr::new("a"), OsStr::new("little"), OsStr::new("lamb")]); - /// - /// let v: Vec<_> = OsStr::new("").split("X").collect(); - /// assert_eq!(v, [OsStr::new("")]); - /// - /// let v: Vec<_> = OsStr::new("lionXXtigerXleopard").split("X").collect(); - /// assert_eq!(v, [OsStr::new("lion"), OsStr::new(""), OsStr::new("tiger"), OsStr::new("leopard")]); - /// - /// let v: Vec<_> = OsStr::new("lion::tiger::leopard").split("::").collect(); - /// assert_eq!(v, [OsStr::new("lion"), OsStr::new("tiger"), OsStr::new("leopard")]); - /// ``` - /// - /// If a string contains multiple contiguous separators, you will end up - /// with empty strings in the output: - /// - /// ``` - /// use std::ffi::OsStr; - /// use clap_lex::OsStrExt as _; - /// let x = OsStr::new("||||a||b|c"); - /// let d: Vec<_> = x.split("|").collect(); - /// - /// assert_eq!(d, &[OsStr::new(""), OsStr::new(""), OsStr::new(""), OsStr::new(""), OsStr::new("a"), OsStr::new(""), OsStr::new("b"), OsStr::new("c")]); - /// ``` - /// - /// Contiguous separators are separated by the empty string. - /// - /// ``` - /// use std::ffi::OsStr; - /// use clap_lex::OsStrExt as _; - /// let x = OsStr::new("(///)"); - /// let d: Vec<_> = x.split("/").collect(); - /// - /// assert_eq!(d, &[OsStr::new("("), OsStr::new(""), OsStr::new(""), OsStr::new(")")]); - /// ``` - /// - /// Separators at the start or end of a string are neighbored - /// by empty strings. - /// - /// ``` - /// use std::ffi::OsStr; - /// use clap_lex::OsStrExt as _; - /// let d: Vec<_> = OsStr::new("010").split("0").collect(); - /// assert_eq!(d, &[OsStr::new(""), OsStr::new("1"), OsStr::new("")]); - /// ``` - /// - /// When the empty string is used as a separator, it panics - /// - /// ```should_panic - /// use std::ffi::OsStr; - /// use clap_lex::OsStrExt as _; - /// let f: Vec<_> = OsStr::new("rust").split("").collect(); - /// assert_eq!(f, &[OsStr::new(""), OsStr::new("r"), OsStr::new("u"), OsStr::new("s"), OsStr::new("t"), OsStr::new("")]); - /// ``` - /// - /// Contiguous separators can lead to possibly surprising behavior - /// when whitespace is used as the separator. This code is correct: - /// - /// ``` - /// use std::ffi::OsStr; - /// use clap_lex::OsStrExt as _; - /// let x = OsStr::new(" a b c"); - /// let d: Vec<_> = x.split(" ").collect(); - /// - /// assert_eq!(d, &[OsStr::new(""), OsStr::new(""), OsStr::new(""), OsStr::new(""), OsStr::new("a"), OsStr::new(""), OsStr::new("b"), OsStr::new("c")]); - /// ``` - /// - /// It does _not_ give you: - /// - /// ```,ignore - /// assert_eq!(d, &[OsStr::new("a"), OsStr::new("b"), OsStr::new("c")]); - /// ``` - /// - /// Use [`split_whitespace`] for this behavior. - /// - /// [`split_whitespace`]: str::split_whitespace - fn split<'s, 'n>(&'s self, needle: &'n str) -> Split<'s, 'n>; - /// Splits the string on the first occurrence of the specified delimiter and - /// returns prefix before delimiter and suffix after delimiter. - /// - /// # Examples - /// - /// ``` - /// use std::ffi::OsStr; - /// use clap_lex::OsStrExt as _; - /// assert_eq!(OsStr::new("cfg").split_once("="), None); - /// assert_eq!(OsStr::new("cfg=").split_once("="), Some((OsStr::new("cfg"), OsStr::new("")))); - /// assert_eq!(OsStr::new("cfg=foo").split_once("="), Some((OsStr::new("cfg"), OsStr::new("foo")))); - /// assert_eq!(OsStr::new("cfg=foo=bar").split_once("="), Some((OsStr::new("cfg"), OsStr::new("foo=bar")))); - /// ``` - fn split_once(&self, needle: &'_ str) -> Option<(&OsStr, &OsStr)>; -} - -impl OsStrExt for OsStr { - fn try_str(&self) -> Result<&str, std::str::Utf8Error> { - let bytes = to_bytes(self); - std::str::from_utf8(bytes) - } - - fn contains(&self, needle: &str) -> bool { - self.find(needle).is_some() - } - - fn find(&self, needle: &str) -> Option<usize> { - let bytes = to_bytes(self); - (0..=self.len().checked_sub(needle.len())?) - .find(|&x| bytes[x..].starts_with(needle.as_bytes())) - } - - fn strip_prefix(&self, prefix: &str) -> Option<&OsStr> { - let bytes = to_bytes(self); - bytes.strip_prefix(prefix.as_bytes()).map(|s| { - // SAFETY: - // - This came from `to_bytes` - // - Since `prefix` is `&str`, any split will be along UTF-8 boundarie - unsafe { to_os_str_unchecked(s) } - }) - } - fn starts_with(&self, prefix: &str) -> bool { - let bytes = to_bytes(self); - bytes.starts_with(prefix.as_bytes()) - } - - fn split<'s, 'n>(&'s self, needle: &'n str) -> Split<'s, 'n> { - assert_ne!(needle, ""); - Split { - haystack: Some(self), - needle, - } - } - - fn split_once(&self, needle: &'_ str) -> Option<(&OsStr, &OsStr)> { - let start = self.find(needle)?; - let end = start + needle.len(); - let haystack = to_bytes(self); - let first = &haystack[0..start]; - let second = &haystack[end..]; - // SAFETY: - // - This came from `to_bytes` - // - Since `needle` is `&str`, any split will be along UTF-8 boundarie - unsafe { Some((to_os_str_unchecked(first), to_os_str_unchecked(second))) } - } -} - -mod private { - pub trait Sealed {} - - impl Sealed for std::ffi::OsStr {} -} - -/// Allow access to raw bytes -/// -/// As the non-UTF8 encoding is not defined, the bytes only make sense when compared with -/// 7-bit ASCII or `&str` -/// -/// # Compatibility -/// -/// There is no guarantee how non-UTF8 bytes will be encoded, even within versions of this crate -/// (since its dependent on rustc) -fn to_bytes(s: &OsStr) -> &[u8] { - // SAFETY: - // - Lifetimes are the same - // - Types are compatible (`OsStr` is effectively a transparent wrapper for `[u8]`) - // - The primary contract is that the encoding for invalid surrogate code points is not - // guaranteed which isn't a problem here - // - // 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) } -} - -/// Restore raw bytes as `OsStr` -/// -/// # Safety -/// -/// - `&[u8]` must either by a `&str` or originated with `to_bytes` within the same binary -/// - Any splits of the original `&[u8]` must be done along UTF-8 boundaries -unsafe fn to_os_str_unchecked(s: &[u8]) -> &OsStr { - // SAFETY: - // - Lifetimes are the same - // - Types are compatible (`OsStr` is effectively a transparent wrapper for `[u8]`) - // - The primary contract is that the encoding for invalid surrogate code points is not - // guaranteed which isn't a problem here - // - // There is a proposal to support this natively (https://github.com/rust-lang/rust/pull/95290) - // but its in limbo - std::mem::transmute(s) -} - -pub struct Split<'s, 'n> { - haystack: Option<&'s OsStr>, - needle: &'n str, -} - -impl<'s, 'n> Iterator for Split<'s, 'n> { - type Item = &'s OsStr; - - fn next(&mut self) -> Option<Self::Item> { - let haystack = self.haystack?; - match haystack.split_once(self.needle) { - Some((first, second)) => { - if !haystack.is_empty() { - debug_assert_ne!(haystack, second); - } - self.haystack = Some(second); - Some(first) - } - None => { - self.haystack = None; - Some(haystack) - } - } - } -} - -/// 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_unchecked(first), to_os_str_unchecked(second)) -} |