1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
use std::str::Utf8Error;
use crate::unix::{
UnixComponent, Utf8UnixComponents, CURRENT_DIR_STR, PARENT_DIR_STR, SEPARATOR_STR,
};
use crate::{private, ParseError, Utf8Component, Utf8Encoding, Utf8Path};
/// `str` slice version of [`std::path::Component`] that represents a Unix-specific component
#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum Utf8UnixComponent<'a> {
RootDir,
CurDir,
ParentDir,
Normal(&'a str),
}
impl<'a> Utf8UnixComponent<'a> {
/// Converts a non-UTF-8 [`UnixComponent`] to a UTF-8 [`Utf8UnixComponent`] by checking that
/// the component contains valid UTF-8.
///
/// # Errors
///
/// Returns `Err` if the component is not UTF-8 with a description as to why the
/// provided component is not UTF-8.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use typed_path::{Utf8Component, unix::{UnixComponent, Utf8UnixComponent}};
///
/// // some bytes, in a vector
/// let component = UnixComponent::Normal(&[240, 159, 146, 150]);
///
/// // We know these bytes are valid, so just use `unwrap()`.
/// let utf8_component = Utf8UnixComponent::from_utf8(&component).unwrap();
///
/// assert_eq!("💖", utf8_component.as_str());
/// ```
///
/// Incorrect bytes:
///
/// ```
/// use typed_path::unix::{UnixComponent, Utf8UnixComponent};
///
/// // some invalid bytes, in a vector
/// let component = UnixComponent::Normal(&[0, 159, 146, 150]);
///
/// assert!(Utf8UnixComponent::from_utf8(&component).is_err());
/// ```
///
/// See the docs for [`Utf8Error`] for more details on the kinds of
/// errors that can be returned.
pub fn from_utf8(component: &UnixComponent<'a>) -> Result<Self, Utf8Error> {
Ok(match component {
UnixComponent::RootDir => Self::RootDir,
UnixComponent::ParentDir => Self::ParentDir,
UnixComponent::CurDir => Self::CurDir,
UnixComponent::Normal(x) => Self::Normal(std::str::from_utf8(x)?),
})
}
/// Converts a non-UTF-8 [`UnixComponent`] to a UTF-8 [`Utf8UnixComponent`] without checking
/// that the string contains valid UTF-8.
///
/// See the safe version, [`from_utf8`], for more information.
///
/// [`from_utf8`]: Utf8UnixComponent::from_utf8
///
/// # Safety
///
/// The bytes passed in must be valid UTF-8.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use typed_path::{Utf8Component, unix::{UnixComponent, Utf8UnixComponent}};
///
/// // some bytes, in a vector
/// let component = UnixComponent::Normal(&[240, 159, 146, 150]);
///
/// let utf8_component = unsafe {
/// Utf8UnixComponent::from_utf8_unchecked(&component)
/// };
///
/// assert_eq!("💖", utf8_component.as_str());
/// ```
pub unsafe fn from_utf8_unchecked(component: &UnixComponent<'a>) -> Self {
match component {
UnixComponent::RootDir => Self::RootDir,
UnixComponent::ParentDir => Self::ParentDir,
UnixComponent::CurDir => Self::CurDir,
UnixComponent::Normal(x) => Self::Normal(std::str::from_utf8_unchecked(x)),
}
}
}
impl private::Sealed for Utf8UnixComponent<'_> {}
impl<'a> Utf8UnixComponent<'a> {
/// Returns path representing this specific component
pub fn as_path<T>(&self) -> &Utf8Path<T>
where
T: for<'enc> Utf8Encoding<'enc>,
{
Utf8Path::new(self.as_str())
}
}
impl<'a> Utf8Component<'a> for Utf8UnixComponent<'a> {
/// Extracts the underlying [`str`] slice
///
/// # Examples
///
/// ```
/// use typed_path::{Utf8Component, Utf8UnixPath};
///
/// let path = Utf8UnixPath::new("/tmp/foo/../bar.txt");
/// let components: Vec<_> = path.components().map(|comp| comp.as_str()).collect();
/// assert_eq!(&components, &["/", "tmp", "foo", "..", "bar.txt"]);
/// ```
fn as_str(&self) -> &'a str {
match self {
Self::RootDir => SEPARATOR_STR,
Self::CurDir => CURRENT_DIR_STR,
Self::ParentDir => PARENT_DIR_STR,
Self::Normal(path) => path,
}
}
/// Returns true if is the root dir component
///
/// # Examples
///
/// ```
/// use typed_path::{Utf8Component, unix::Utf8UnixComponent};
/// use std::convert::TryFrom;
///
/// let root_dir = Utf8UnixComponent::try_from("/").unwrap();
/// assert!(root_dir.is_root());
///
/// let normal = Utf8UnixComponent::try_from("file.txt").unwrap();
/// assert!(!normal.is_root());
/// ```
fn is_root(&self) -> bool {
matches!(self, Self::RootDir)
}
/// Returns true if is a normal component
///
/// # Examples
///
/// ```
/// use typed_path::{Utf8Component, unix::Utf8UnixComponent};
/// use std::convert::TryFrom;
///
/// let normal = Utf8UnixComponent::try_from("file.txt").unwrap();
/// assert!(normal.is_normal());
///
/// let root_dir = Utf8UnixComponent::try_from("/").unwrap();
/// assert!(!root_dir.is_normal());
/// ```
fn is_normal(&self) -> bool {
matches!(self, Self::Normal(_))
}
/// Returns true if is a parent directory component
///
/// # Examples
///
/// ```
/// use typed_path::{Utf8Component, unix::Utf8UnixComponent};
/// use std::convert::TryFrom;
///
/// let parent = Utf8UnixComponent::try_from("..").unwrap();
/// assert!(parent.is_parent());
///
/// let root_dir = Utf8UnixComponent::try_from("/").unwrap();
/// assert!(!root_dir.is_parent());
/// ```
fn is_parent(&self) -> bool {
matches!(self, Self::ParentDir)
}
/// Returns true if is the current directory component
///
/// # Examples
///
/// ```
/// use typed_path::{Utf8Component, unix::Utf8UnixComponent};
/// use std::convert::TryFrom;
///
/// let current = Utf8UnixComponent::try_from(".").unwrap();
/// assert!(current.is_current());
///
/// let root_dir = Utf8UnixComponent::try_from("/").unwrap();
/// assert!(!root_dir.is_current());
/// ```
fn is_current(&self) -> bool {
matches!(self, Self::CurDir)
}
fn len(&self) -> usize {
self.as_str().len()
}
/// Returns the root directory component.
///
/// # Examples
///
/// ```
/// use typed_path::{Utf8Component, unix::Utf8UnixComponent};
///
/// assert_eq!(Utf8UnixComponent::root(), Utf8UnixComponent::RootDir);
/// ```
fn root() -> Self {
Self::RootDir
}
/// Returns the parent directory component.
///
/// # Examples
///
/// ```
/// use typed_path::{Utf8Component, unix::Utf8UnixComponent};
///
/// assert_eq!(Utf8UnixComponent::parent(), Utf8UnixComponent::ParentDir);
/// ```
fn parent() -> Self {
Self::ParentDir
}
/// Returns the current directory component.
///
/// # Examples
///
/// ```
/// use typed_path::{Utf8Component, unix::Utf8UnixComponent};
///
/// assert_eq!(Utf8UnixComponent::current(), Utf8UnixComponent::CurDir);
/// ```
fn current() -> Self {
Self::CurDir
}
}
impl AsRef<[u8]> for Utf8UnixComponent<'_> {
#[inline]
fn as_ref(&self) -> &[u8] {
self.as_str().as_bytes()
}
}
impl AsRef<str> for Utf8UnixComponent<'_> {
#[inline]
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl<T> AsRef<Utf8Path<T>> for Utf8UnixComponent<'_>
where
T: for<'enc> Utf8Encoding<'enc>,
{
#[inline]
fn as_ref(&self) -> &Utf8Path<T> {
Utf8Path::new(self.as_str())
}
}
impl<'a> TryFrom<UnixComponent<'a>> for Utf8UnixComponent<'a> {
type Error = Utf8Error;
#[inline]
fn try_from(component: UnixComponent<'a>) -> Result<Self, Self::Error> {
Self::from_utf8(&component)
}
}
impl<'a> TryFrom<&'a str> for Utf8UnixComponent<'a> {
type Error = ParseError;
/// Parses the `str` slice into a [`Utf8UnixComponent`]
///
/// # Examples
///
/// ```
/// use typed_path::unix::Utf8UnixComponent;
/// use std::convert::TryFrom;
///
/// // Supports parsing standard unix path components
/// assert_eq!(Utf8UnixComponent::try_from("/"), Ok(Utf8UnixComponent::RootDir));
/// assert_eq!(Utf8UnixComponent::try_from("."), Ok(Utf8UnixComponent::CurDir));
/// assert_eq!(Utf8UnixComponent::try_from(".."), Ok(Utf8UnixComponent::ParentDir));
/// assert_eq!(Utf8UnixComponent::try_from("file.txt"), Ok(Utf8UnixComponent::Normal("file.txt")));
/// assert_eq!(Utf8UnixComponent::try_from("dir/"), Ok(Utf8UnixComponent::Normal("dir")));
///
/// // Parsing more than one component will fail
/// assert!(Utf8UnixComponent::try_from("/file").is_err());
/// ```
fn try_from(path: &'a str) -> Result<Self, Self::Error> {
let mut components = Utf8UnixComponents::new(path);
let component = components.next().ok_or("no component found")?;
if components.next().is_some() {
return Err("found more than one component");
}
Ok(component)
}
}