Skip to content

Commit

Permalink
feat: add custom CowStr type
Browse files Browse the repository at this point in the history
Related issue: #20
  • Loading branch information
kmaasrud committed Mar 21, 2023
1 parent 16491a4 commit 75dcfb2
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 4 deletions.
5 changes: 2 additions & 3 deletions src/attr.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
use crate::CowStr;
use crate::DiscontinuousString;
use crate::Span;
use std::borrow::Cow;
use std::fmt;

use State::*;
Expand Down Expand Up @@ -117,8 +116,8 @@ impl<'s> Attributes<'s> {
#[inline]
fn borrow(cow: CowStr) -> &str {
match cow {
Cow::Owned(_) => panic!(),
Cow::Borrowed(s) => s,
CowStr::Owned(_) | CowStr::Inlined(_, _) => panic!(),
CowStr::Borrowed(s) => s,
}
}

Expand Down
10 changes: 9 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,16 @@ mod block;
mod inline;
mod lex;
mod span;
mod string;
mod tree;

use span::DiscontinuousString;
use span::Span;

pub use attr::{AttributeValue, AttributeValueParts, Attributes};
pub use string::CowStr;

type CowStr<'s> = std::borrow::Cow<'s, str>;
// type CowStr<'s> = std::borrow::Cow<'s, str>;

pub trait Render {
/// Push [`Event`]s to a unicode-accepting buffer or stream.
Expand Down Expand Up @@ -698,6 +700,7 @@ impl<'s> Parser<'s> {
format: match self.inlines.src(inline.span) {
CowStr::Owned(_) => panic!(),
CowStr::Borrowed(s) => s,
CowStr::Inlined(..) => todo!(),
},
},
inline::Container::Subscript => Container::Subscript,
Expand All @@ -711,20 +714,23 @@ impl<'s> Parser<'s> {
match self.inlines.src(inline.span) {
CowStr::Owned(s) => s.replace('\n', "").into(),
s @ CowStr::Borrowed(_) => s,
CowStr::Inlined(..) => todo!(),
},
LinkType::Span(SpanLinkType::Inline),
),
inline::Container::InlineImage => Container::Image(
match self.inlines.src(inline.span) {
CowStr::Owned(s) => s.replace('\n', "").into(),
s @ CowStr::Borrowed(_) => s,
CowStr::Inlined(..) => todo!(),
},
SpanLinkType::Inline,
),
inline::Container::ReferenceLink | inline::Container::ReferenceImage => {
let tag = match self.inlines.src(inline.span) {
CowStr::Owned(s) => s.replace('\n', " ").into(),
s @ CowStr::Borrowed(_) => s,
CowStr::Inlined(..) => todo!(),
};
let link_def =
self.pre_pass.link_definitions.get(tag.as_ref()).cloned();
Expand Down Expand Up @@ -765,6 +771,7 @@ impl<'s> Parser<'s> {
let tag = match self.inlines.src(inline.span) {
CowStr::Borrowed(s) => s,
CowStr::Owned(..) => panic!(),
CowStr::Inlined(..) => todo!(),
};
let number = self
.footnote_references
Expand All @@ -781,6 +788,7 @@ impl<'s> Parser<'s> {
match self.inlines.src(inline.span) {
CowStr::Borrowed(s) => s,
CowStr::Owned(..) => panic!(),
CowStr::Inlined(..) => todo!(),
},
number,
)
Expand Down
94 changes: 94 additions & 0 deletions src/string.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
use std::{borrow::Borrow, fmt::Display, ops::Deref, str::from_utf8};

// Largest CowStr variant is Owned(String). A String uses 3 words of memory, but a fourth word is
// needed to hold the tag (the tag takes a byte, but a full word is used for alignment reasons.)
// This means that the available space we have for an inline string is 4 words - 1 byte for the tag
// and 1 word for encoding the length.
const MAX_INLINE_STR_LEN: usize = 4 * std::mem::size_of::<usize>() - 2;

#[derive(Debug)]
pub enum CowStr<'s> {
Owned(String),
Borrowed(&'s str),
Inlined([u8; MAX_INLINE_STR_LEN], u8),
}

impl<'s> Deref for CowStr<'s> {
type Target = str;

fn deref(&self) -> &Self::Target {
match *self {
Self::Owned(ref s) => s.borrow(),
Self::Borrowed(s) => s,
// NOTE: Inlined strings can only be constructed from strings or chars, which means they
// are guaranteed to be valid UTF-8. We could consider unchecked conversion as well, but
// a benchmark should be done before introducing unsafes.
Self::Inlined(ref inner, len) => from_utf8(&inner[..len as usize]).unwrap(),
}
}
}

impl<'s> AsRef<str> for CowStr<'s> {
fn as_ref(&self) -> &str {
self.deref()
}
}

impl<'s> From<char> for CowStr<'s> {
fn from(value: char) -> Self {
let mut inner = [0u8; MAX_INLINE_STR_LEN];
value.encode_utf8(&mut inner);
CowStr::Inlined(inner, value.len_utf8() as u8)
}
}

impl<'s> From<&'s str> for CowStr<'s> {
fn from(value: &'s str) -> Self {
CowStr::Borrowed(value)
}
}

impl<'s> From<String> for CowStr<'s> {
fn from(value: String) -> Self {
CowStr::Owned(value)
}
}

impl<'s> Clone for CowStr<'s> {
fn clone(&self) -> Self {
match self {
CowStr::Owned(s) => {
let len = s.len();
if len > MAX_INLINE_STR_LEN {
CowStr::Owned(s.clone())
} else {
let mut inner = [0u8; MAX_INLINE_STR_LEN];
inner[..len].copy_from_slice(s.as_bytes());
CowStr::Inlined(inner, len as u8)
}
}
CowStr::Borrowed(s) => CowStr::Borrowed(s),
CowStr::Inlined(inner, len) => CowStr::Inlined(*inner, *len),
}
}
}

impl<'s> PartialEq for CowStr<'s> {
fn eq(&self, other: &Self) -> bool {
self.deref() == other.deref()
}
}

impl<'s> Eq for CowStr<'s> {}

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

impl<'s, 'a> FromIterator<&'a str> for CowStr<'s> {
fn from_iter<T: IntoIterator<Item = &'a str>>(iter: T) -> Self {
CowStr::Owned(FromIterator::from_iter(iter))
}
}

0 comments on commit 75dcfb2

Please sign in to comment.