swift_rs/types/
string.rs

1use std::{
2    fmt::{Display, Error, Formatter},
3    ops::Deref,
4};
5
6use crate::{
7    swift::{self, SwiftObject},
8    Int, SRData, SRObject,
9};
10
11/// String type that can be shared between Swift and Rust.
12///
13/// ```rust
14/// use swift_rs::{swift, SRString};
15///
16/// swift!(fn get_greeting(name: &SRString) -> SRString);
17///
18/// let greeting = unsafe { get_greeting(&"Brendan".into()) };
19///
20/// assert_eq!(greeting.as_str(), "Hello Brendan!");
21/// ```
22/// [_corresponding Swift code_](https://github.com/Brendonovich/swift-rs/blob/07269e511f1afb71e2fcfa89ca5d7338bceb20e8/tests/swift-pkg/doctests.swift#L56)
23#[repr(transparent)]
24pub struct SRString(SRData);
25
26impl SRString {
27    pub fn as_str(&self) -> &str {
28        unsafe { std::str::from_utf8_unchecked(&self.0) }
29    }
30}
31
32impl SwiftObject for SRString {
33    type Shape = <SRData as SwiftObject>::Shape;
34
35    fn get_object(&self) -> &SRObject<Self::Shape> {
36        self.0.get_object()
37    }
38}
39
40impl Deref for SRString {
41    type Target = str;
42
43    fn deref(&self) -> &Self::Target {
44        self.as_str()
45    }
46}
47
48impl AsRef<[u8]> for SRString {
49    fn as_ref(&self) -> &[u8] {
50        self.0.as_ref()
51    }
52}
53
54impl From<&str> for SRString {
55    fn from(string: &str) -> Self {
56        unsafe { swift::string_from_bytes(string.as_ptr(), string.len() as Int) }
57    }
58}
59
60impl Display for SRString {
61    fn fmt(&self, f: &mut Formatter) -> Result<(), Error> {
62        self.as_str().fmt(f)
63    }
64}
65
66#[cfg(feature = "serde")]
67impl serde::Serialize for SRString {
68    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
69    where
70        S: serde::Serializer,
71    {
72        serializer.serialize_str(self.as_str())
73    }
74}
75#[cfg(feature = "serde")]
76impl<'a> serde::Deserialize<'a> for SRString {
77    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
78    where
79        D: serde::Deserializer<'a>,
80    {
81        let string = String::deserialize(deserializer)?;
82        Ok(SRString::from(string.as_str()))
83    }
84}
swift_rs/types/string.rs

swift_rs/types/
string.rs
