Files
zed/crates/gpui_shared_string/gpui_shared_string.rs
T
Finn Evers 9dd6993e2e gpui_shared_string: Avoid intermediate string allocation when deserializing a SharedString (#65089)
## Summary

This PR improves how we deserialize SharedStrings. Since we moved to
`SmolStr` under the hood some time ago, which takes a string by `impl
AsRef<str>` in its constructor, we can get rid here of allocating a
string where possible in favor of using a stringvisitor during
deserialization. This provides us with some decent improvements.

## Testing

The benchmark results are the following:

| Case | `from_str` before | `from_str` after | Δ | 
|---|---:|---:|---:|
| short (≤23 B, inline) | 23.1 µs | 11.6 µs | −50% 
| short, escaped | 33.2 µs | 22.4 µs | −32% | 
| long (~66 B, heap) | 46.9 µs | 31.4 µs | −33% | 
| long, escaped | 307.6 µs | 267.6 µs | −13% | 

## Self-review

- [X] I've reviewed my diff for quality, security, reliability, and
performance.
- [-] UI changes follow the
[checklist](https://zed.dev/docs/development/ui-checklist).
- [-] Tests cover the new or changed behavior.

Release Notes:

- N/A
- [GPUI] Improved memory usage and performance when deserializing
SharedStrings.
2026-10-02 13:48:20 +00:00

211 lines
4.5 KiB
Rust

use std::{
borrow::{Borrow, Cow},
iter,
sync::Arc,
};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use smol_str::SmolStr;
/// A shared string is an immutable string that can be cheaply cloned in GPUI
/// tasks. Essentially an abstraction over an `Arc<str>` and `&'static str`,
/// currently backed by a [`SmolStr`].
#[derive(Eq, PartialEq, PartialOrd, Ord, Hash, Clone)]
pub struct SharedString(SmolStr);
impl std::ops::Deref for SharedString {
type Target = str;
fn deref(&self) -> &Self::Target {
self.0.as_str()
}
}
impl SharedString {
/// Creates a static [`SharedString`] from a `&'static str`.
pub const fn new_static(str: &'static str) -> Self {
Self(SmolStr::new_static(str))
}
/// Creates a [`SharedString`].
pub fn new(str: impl AsRef<str>) -> Self {
SharedString(SmolStr::new(str))
}
/// Get a &str from the underlying string.
pub fn as_str(&self) -> &str {
&self.0
}
}
impl JsonSchema for SharedString {
fn inline_schema() -> bool {
String::inline_schema()
}
fn schema_name() -> Cow<'static, str> {
String::schema_name()
}
fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
String::json_schema(generator)
}
}
impl Default for SharedString {
fn default() -> Self {
Self::new_static("")
}
}
impl AsRef<str> for SharedString {
fn as_ref(&self) -> &str {
&self.0
}
}
impl Borrow<str> for SharedString {
fn borrow(&self) -> &str {
self.as_ref()
}
}
impl std::fmt::Debug for SharedString {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.0.fmt(f)
}
}
impl std::fmt::Display for SharedString {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0.as_str())
}
}
impl PartialEq<String> for SharedString {
fn eq(&self, other: &String) -> bool {
self.as_ref() == other
}
}
impl PartialEq<SharedString> for String {
fn eq(&self, other: &SharedString) -> bool {
self == other.as_ref()
}
}
impl PartialEq<str> for SharedString {
fn eq(&self, other: &str) -> bool {
self.as_ref() == other
}
}
impl<'a> PartialEq<&'a str> for SharedString {
fn eq(&self, other: &&'a str) -> bool {
self.as_ref() == *other
}
}
impl From<&SharedString> for SharedString {
#[inline]
fn from(s: &SharedString) -> SharedString {
s.clone()
}
}
impl From<&str> for SharedString {
#[inline]
fn from(s: &str) -> SharedString {
SharedString(SmolStr::from(s))
}
}
impl From<char> for SharedString {
#[inline]
fn from(c: char) -> SharedString {
SharedString(SmolStr::from_iter(iter::once(c)))
}
}
impl From<&mut str> for SharedString {
#[inline]
fn from(s: &mut str) -> SharedString {
SharedString(SmolStr::from(s))
}
}
impl From<&String> for SharedString {
#[inline]
fn from(s: &String) -> SharedString {
SharedString(SmolStr::from(s))
}
}
impl From<String> for SharedString {
#[inline(always)]
fn from(text: String) -> Self {
SharedString(SmolStr::from(text))
}
}
impl From<Box<str>> for SharedString {
#[inline]
fn from(s: Box<str>) -> SharedString {
SharedString(SmolStr::from(s))
}
}
impl From<Arc<str>> for SharedString {
#[inline]
fn from(s: Arc<str>) -> SharedString {
SharedString(SmolStr::from(s))
}
}
impl From<&Arc<str>> for SharedString {
#[inline]
fn from(s: &Arc<str>) -> SharedString {
SharedString(SmolStr::from(s.clone()))
}
}
impl<'a> From<Cow<'a, str>> for SharedString {
#[inline]
fn from(s: Cow<'a, str>) -> SharedString {
SharedString(SmolStr::from(s))
}
}
impl From<SharedString> for Arc<str> {
#[inline(always)]
fn from(text: SharedString) -> Self {
text.0.into()
}
}
impl From<SharedString> for String {
#[inline(always)]
fn from(text: SharedString) -> Self {
text.0.into()
}
}
impl Serialize for SharedString {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
serializer.serialize_str(self.as_ref())
}
}
impl<'de> Deserialize<'de> for SharedString {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
SmolStr::deserialize(deserializer).map(SharedString)
}
}