Received-SPF: pass (google.com: domain of linux-kernel+bounces-69046-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Message-ID: <18a49662-3640-49c1-9587-db5cc9d62fbc@redhat.com>
Date: Fri, 16 Feb 2024 18:11:30 +0100
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v3] rust: str: add {make,to}_{upper,lower}case() to
 CString
Content-Language: en-US
To: Alice Ryhl <aliceryhl@google.com>
Cc: a.hindborg@samsung.com, alex.gaynor@gmail.com, benno.lossin@proton.me,
 bjorn3_gh@protonmail.com, boqun.feng@gmail.com, gary@garyguo.net,
 linux-kernel@vger.kernel.org, ojeda@kernel.org,
 rust-for-linux@vger.kernel.org, wedsonaf@gmail.com
References: <20240214172505.5044-1-dakr@redhat.com>
 <20240216165320.1820346-1-aliceryhl@google.com>
From: Danilo Krummrich <dakr@redhat.com>
Organization: RedHat
In-Reply-To: <20240216165320.1820346-1-aliceryhl@google.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit

On 2/16/24 17:53, Alice Ryhl wrote:
>> +    pub fn make_ascii_lowercase(&mut self) {
>> +        self.0.make_ascii_lowercase();
>> +    }
> 
> It's important to note here that this doesn't remove or introduce NUL
> bytes.
> 
> pub fn make_ascii_lowercase(&mut self) {
>      // INVARIANT: This doesn't introduce or remove NUL bytes in the c
>      // string.
>      self.0.make_ascii_lowercase();
> }
> 
> Ditto for make_ascii_uppercase. (But not the to_* methods.)
> 
>> +    /// Returns a copy of this [`CString`] where each character is mapped to its
>> +    /// ASCII lower case equivalent.
>> +    ///
>> +    /// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
>> +    /// but non-ASCII letters are unchanged.
>> +    ///
>> +    /// To lowercase the value in-place, use [`make_ascii_lowercase`].
>> +    ///
>> +    /// [`make_ascii_lowercase`]: str::make_ascii_lowercase
>> +    pub fn to_ascii_lowercase(&self) -> Result<CString, AllocError> {
>> +        let mut s = (*self).to_cstring()?;
>> +
>> +        s.make_ascii_lowercase();
>> +
>> +        return Ok(s);
>> +    }
>> +
>> +    /// Returns a copy of this [`CString`] where each character is mapped to its
>> +    /// ASCII upper case equivalent.
>> +    ///
>> +    /// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
>> +    /// but non-ASCII letters are unchanged.
>> +    ///
>> +    /// To uppercase the value in-place, use [`make_ascii_uppercase`].
>> +    ///
>> +    /// [`make_ascii_uppercase`]: str::make_ascii_uppercase
>> +    pub fn to_ascii_uppercase(&self) -> Result<CString, AllocError> {
>> +        let mut s = (*self).to_cstring()?;
>> +
>> +        s.make_ascii_uppercase();
>> +
>> +        return Ok(s);
>> +    }
> 
> Please move these to `CStr` as well.

That would result into two copies if I actually want a CString, wouldn't it?

Also, what would be the use case? And even if someone wants to have a CStr
again, couldn't we just deref the resulting CString?

- Danilo

> 
>> +impl DerefMut for CString {
>> +    fn deref_mut(&mut self) -> &mut Self::Target {
>> +        unsafe { CStr::from_bytes_with_nul_unchecked_mut(&mut *self.buf) }
>> +    }
>> +}
> 
> Needs a safety comment.
> 
> impl DerefMut for CString {
>      fn deref_mut(&mut self) -> &mut Self::Target {
>          // SAFETY: A `CString` is always NUL-terminated and contains no
> 	// other NUL bytes.
>          unsafe { CStr::from_bytes_with_nul_unchecked_mut(&mut *self.buf) }
>      }
> }
> 
> Alice
>