Skip to content

Allow passing String to Encoding::encode #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3257,11 +3257,36 @@ impl Encoding {
///
/// Available to Rust only and only with the `alloc` feature enabled (enabled
/// by default).
///
/// # Examples
///
/// `encode` can be used with either `&str` or `String`.
/// ```
/// let encoding = encoding_rs::UTF_8;
/// let (bytes, output_encoding, saw_unmappable_chars) = encoding.encode("some string");
/// let (bytes, output_encoding, saw_unmappable_chars) = encoding.encode(String::from("some string"));
/// ```
#[cfg(feature = "alloc")]
pub fn encode<'a>(&'static self, string: &'a str) -> (Cow<'a, [u8]>, &'static Encoding, bool) {
pub fn encode<'a>(
&'static self,
string: impl Into<Cow<'a, str>>,
) -> (Cow<'a, [u8]>, &'static Encoding, bool) {
self.encode_(string.into())
}

/// Non-generic version of `encode`, to avoid monomorphizing a large amount of code many times.
fn encode_<'a>(
&'static self,
string: Cow<'a, str>,
) -> (Cow<'a, [u8]>, &'static Encoding, bool) {
let to_cow_bytes = |string: Cow<'a, str>| match string {
Cow::Owned(string) => Cow::Owned(string.into_bytes()),
Cow::Borrowed(str) => Cow::Borrowed(str.as_bytes()),
};

let output_encoding = self.output_encoding();
if output_encoding == UTF_8 {
return (Cow::Borrowed(string.as_bytes()), output_encoding, false);
return (to_cow_bytes(string), output_encoding, false);
}
debug_assert!(output_encoding.is_potentially_borrowable());
let bytes = string.as_bytes();
Expand All @@ -3271,7 +3296,7 @@ impl Encoding {
ascii_valid_up_to(bytes)
};
if valid_up_to == bytes.len() {
return (Cow::Borrowed(bytes), output_encoding, false);
return (to_cow_bytes(string), output_encoding, false);
}
let mut encoder = output_encoding.new_encoder();
let mut vec: Vec<u8> = Vec::with_capacity(
Expand Down