wimlib 0.3.2

(Hopefully) idomatic bindings to the wimlib library
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

use {
	beef::lean::Cow,
	derive_more::{Display, Error},
	std::{
		ffi::{c_char, CStr, FromBytesWithNulError},
		fmt::{Debug, Display},
		str::Utf8Error,
	},
};

pub(crate) type ItemType = c_char;

/// WimLib's Unicode C string wrapper
#[derive(PartialEq, Eq)]
#[repr(transparent)]
pub struct TStr {
	pub(super) inner: CStr,
}

impl TStr {
	/// Create a [`TStr`] reference from its underlying
	/// implementation
	pub const fn from_impl(cstr: &CStr) -> &Self {
		unsafe { &*(cstr as *const CStr as *const Self) }
	}

	/// Get inner pointer
	pub const fn as_ptr(&self) -> *const c_char {
		self.inner.as_ptr()
	}

	/// Create from codepoint from nul-terminated UTF-8 slice
	///
	/// Refer to [`CStr::from_bytes_with_nul`]
	pub fn from_slice(slice: &[u8]) -> Result<&Self, impl std::error::Error> {
		if let Err(e) = std::str::from_utf8(slice) {
			return Err(FromSliceError::Unicode(e));
		}

		let cstr = CStr::from_bytes_with_nul(slice).map_err(FromSliceError::Nul)?;
		Ok(Self::from_impl(cstr))
	}

	/// Wrap a raw string
	///
	/// # Safety
	/// - Refer to [`CStr::from_ptr`]
	/// - Additionally, the string has to be valid UTF-8
	pub unsafe fn from_ptr<'a>(ptr: *const c_char) -> &'a Self {
		let cstr = unsafe { CStr::from_ptr(ptr) };
		Self::from_impl(cstr)
	}

	/// Wrap a raw string, which may be `NULL` into optional string
	///
	/// # Safety
	/// - Refer to [`Self::from_ptr`]
	/// - Pointer can be `NULL`, then [`None`] is returned
	pub unsafe fn from_ptr_optional<'a>(ptr: *const c_char) -> Option<&'a Self> {
		(!ptr.is_null()).then(|| unsafe { Self::from_ptr(ptr) })
	}

	/// Cast to Rust string
	pub fn to_str(&self) -> Cow<str> {
		self.as_str().into()
	}

	/// Get the lenght of string
	pub const fn len(&self) -> usize {
		self.inner.to_bytes().len()
	}

	/// Is string empty?
	pub const fn is_empty(&self) -> bool {
		self.len() == 0
	}

	/// Get iterator of [`char`]
	pub fn chars(&self) -> impl Iterator<Item = char> + '_ {
		self.as_str().chars()
	}

	fn as_str(&self) -> &str {
		// SAFETY: Library promises us UTF-8
		let string = unsafe { &*(self as *const Self as *const str) };
		&string[0..string.len() - 1]
	}
}

#[derive(Clone, Debug, Display, Error)]
pub enum FromSliceError {
	Unicode(Utf8Error),
	Nul(FromBytesWithNulError),
}

impl Debug for TStr {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		Debug::fmt(self.as_str(), f)
	}
}

impl Display for TStr {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		Display::fmt(self.as_str(), f)
	}
}