flexstr 0.11.7

A flexible, simple to use, clone-efficient string type for Rust
Documentation 
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

use alloc::{borrow::Cow, rc::Rc, sync::Arc};
use core::{convert::Infallible, str::FromStr};
use std::ffi::{OsStr, OsString};
use std::path::Path;
#[cfg(feature = "path")]
use std::path::PathBuf;

use crate::flex::{
    FlexStr, ImmutableBytes, RefCounted, RefCountedMut, partial_eq_impl, ref_counted_mut_impl,
};

use flexstr_support::StringToFromBytes;

/// Local `OsStr` type (NOTE: This can't be shared between threads)
pub type LocalOsStr = FlexStr<'static, OsStr, Rc<OsStr>>;

/// Shared `OsStr` type
pub type SharedOsStr = FlexStr<'static, OsStr, Arc<OsStr>>;

/// Local `OsStr` type that can optionally hold borrows (NOTE: This can't be shared between threads)
pub type LocalOsStrRef<'s> = FlexStr<'s, OsStr, Rc<OsStr>>;

/// Shared `OsStr` type that can optionally hold borrows
pub type SharedOsStrRef<'s> = FlexStr<'s, OsStr, Arc<OsStr>>;

const _: () = assert!(
    size_of::<Option<LocalOsStr>>() <= size_of::<OsString>(),
    "Option<LocalOsStr> must be less than or equal to the size of OsString"
);
const _: () = assert!(
    size_of::<Option<SharedOsStr>>() <= size_of::<OsString>(),
    "Option<SharedOsStr> must be less than or equal to the size of OsString"
);

// *** ImmutableBytes ***

impl ImmutableBytes for OsStr {}

// *** RefCountedMut ***

ref_counted_mut_impl!(OsStr);

// *** From for FlexStr ***

// NOTE: Cannot be implemented generically because of impl<T> From<T> for T
impl<'s, R: RefCounted<OsStr>> From<OsString> for FlexStr<'s, OsStr, R> {
    fn from(s: OsString) -> Self {
        FlexStr::from_owned(s)
    }
}

impl<'s, R: RefCounted<OsStr>> From<String> for FlexStr<'s, OsStr, R> {
    fn from(s: String) -> Self {
        FlexStr::from_owned(s.into())
    }
}

#[cfg(feature = "path")]
impl<'s, R: RefCounted<OsStr>> From<PathBuf> for FlexStr<'s, OsStr, R> {
    fn from(p: PathBuf) -> Self {
        FlexStr::from_owned(p.into())
    }
}

impl<'s, R: RefCounted<OsStr>> From<&'s str> for FlexStr<'s, OsStr, R> {
    fn from(s: &'s str) -> Self {
        FlexStr::from_borrowed(OsStr::new(s))
    }
}

impl<'s, R: RefCounted<OsStr>> From<&'s Path> for FlexStr<'s, OsStr, R> {
    fn from(p: &'s Path) -> Self {
        FlexStr::from_borrowed(p.as_os_str())
    }
}

// *** PartialEq ***

partial_eq_impl!(OsStr, OsStr);
partial_eq_impl!(&OsStr, OsStr);
partial_eq_impl!(OsString, OsStr);
partial_eq_impl!(Cow<'s, OsStr>, OsStr);

// *** AsRef ***

impl<'s, S: ?Sized + StringToFromBytes, R: RefCounted<S>> AsRef<OsStr> for FlexStr<'s, S, R>
where
    S: AsRef<OsStr>,
{
    fn as_ref(&self) -> &OsStr {
        self.as_ref_type().as_ref()
    }
}

// *** FromStr ***

impl<R: RefCounted<OsStr>> FromStr for FlexStr<'static, OsStr, R> {
    type Err = Infallible;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(FlexStr::from_borrowed(OsStr::new(s)).into_owned())
    }
}