From 8ae174bd361d61a086ed68646b746a302cf0e524 Mon Sep 17 00:00:00 2001 From: overlookmotel <557937+overlookmotel@users.noreply.github.com> Date: Sun, 13 Oct 2024 09:51:49 +0000 Subject: [PATCH] refactor(codegen): rename `CodeBuffer::print_byte_unchecked` method (#6496) Pure refactor. `*_unchecked` is the conventional name for unsafe methods, not `*_unsafe`. --- crates/oxc_codegen/src/code_buffer.rs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/crates/oxc_codegen/src/code_buffer.rs b/crates/oxc_codegen/src/code_buffer.rs index 9c6461d6ce9a7..dcc49b23a7af7 100644 --- a/crates/oxc_codegen/src/code_buffer.rs +++ b/crates/oxc_codegen/src/code_buffer.rs @@ -185,18 +185,18 @@ impl CodeBuffer { /// let mut code = CodeBuffer::new(); /// // Safe: 'a' is a valid ASCII character. Its UTF-8 representation only /// // requires a single byte. - /// unsafe { code.print_byte_unsafe(b'a') }; + /// unsafe { code.print_byte_unchecked(b'a') }; /// /// let not_ascii = '⚓'; /// let as_bytes = not_ascii.to_string().into_bytes(); /// // Safe: after this loop completes, `code` returns to a valid state. /// for byte in as_bytes { - /// unsafe { code.print_byte_unsafe(byte) }; + /// unsafe { code.print_byte_unchecked(byte) }; /// } /// /// // NOT SAFE: `ch` exceeds the ASCII segment range. `code` is no longer /// valid UTF-8 - /// unsafe { code.print_byte_unsafe(0xFF) }; + /// unsafe { code.print_byte_unchecked(0xFF) }; /// ``` /// /// [`print_ascii_byte`]: CodeBuffer::print_ascii_byte @@ -204,7 +204,7 @@ impl CodeBuffer { /// [`take_source_text`]: CodeBuffer::take_source_text /// [`print_unchecked`]: CodeBuffer::print_unchecked #[inline] - pub unsafe fn print_byte_unsafe(&mut self, ch: u8) { + pub unsafe fn print_byte_unchecked(&mut self, ch: u8) { self.buf.push(ch); } @@ -285,7 +285,7 @@ impl CodeBuffer { /// a valid UTF-8 string. In practice, this means only two cases are valid: /// /// 1. Both the buffer and the byte sequence are valid UTF-8, - /// 2. The buffer became invalid after a call to [`print_byte_unsafe`] and `bytes` + /// 2. The buffer became invalid after a call to [`print_byte_unchecked`] and `bytes` /// completes any incomplete code points, returning the buffer to a valid /// state. /// @@ -302,7 +302,7 @@ impl CodeBuffer { /// } /// ``` /// - /// [`print_byte_unsafe`]: CodeBuffer::print_byte_unsafe + /// [`print_byte_unchecked`]: CodeBuffer::print_byte_unchecked #[inline] pub(crate) unsafe fn print_unchecked(&mut self, bytes: I) where @@ -400,7 +400,7 @@ mod test { #[test] #[allow(clippy::byte_char_slices)] - fn test_print_byte_unsafe() { + fn test_print_byte_unchecked() { let mut code = CodeBuffer::new(); code.print_ascii_byte(b'f'); code.print_ascii_byte(b'o');