Edition bump and bugfix in log UTF8 handling

Author: cloone8

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 This file will document the most important changes for each released version
 
+## [v0.2.6]
+
+### Changes
+
+- Update crate to edition 2024
+
+### Bugfixes
+
+- Logger does not panic anymore when given UTF8 with the NUL codepoint. They are now replaced with `char::REPLACEMENT_CHARACTER`
+
 ## [v0.2.5]
 
 ### Changes

Cargo.toml

@@ -3,22 +3,22 @@ resolver = "2"
 members = ["unity_native", "unity_native_proc_macro", "unity_native_sys"]
 
 [workspace.package]
-version = "0.2.5"
-edition = "2021"
+version = "0.2.6"
+edition = "2024"
 authors = ["Wouter de Bruijn <[email protected]>"]
 repository = "https://github.com/cloone8/unity-native"
 license = "MIT"
 keywords = []
 categories = []
 
 [workspace.dependencies]
-unity_native = { path = "unity_native", version = "0.2.5" }
-unity_native_proc_macro = { path = "unity_native_proc_macro", version = "0.2.5" }
-unity_native_sys = { path = "unity_native_sys", version = "0.2.5" }
-bindgen = "0.69.4"
-syn = "2.0.68"
-quote = "1.0.36"
-thiserror = "1.0.61"
-log = "0.4.22"
+unity_native = { path = "unity_native", version = "0.2.6" }
+unity_native_proc_macro = { path = "unity_native_proc_macro", version = "0.2.6" }
+unity_native_sys = { path = "unity_native_sys", version = "0.2.6" }
+bindgen = "0.71.1"
+syn = "2.0.100"
+quote = "1.0.40"
+thiserror = "2.0.12"
+log = "0.4.27"
 static_assertions = "1.1.0"
 mint = "0.5.9"

unity_native/src/logger.rs

@@ -2,7 +2,7 @@ use std::{ffi::CString, ptr::NonNull};
 
 use log::Log;
 
-use crate::{ffi, unity_api_guid, UnityInterface};
+use crate::{UnityInterface, ffi, unity_api_guid};
 
 /// A wrapper for the Unity Logging API. It supports
 /// both manual logging using [UnityLogger::log_generic] (and friends),
@@ -97,9 +97,10 @@ impl UnityLogger {
     /// the function generating the log, so using the Rust [file!] and [line!]
     /// macros is recommended
     pub fn log_generic(&self, level: UnityLogType, msg: &str, filename: &str, line: u32) {
-        let line_c = std::os::raw::c_int::try_from(line).unwrap();
-        let message_c_str = CString::new(msg).unwrap();
-        let filename_c_str = CString::new(filename).unwrap();
+        let line_c = std::os::raw::c_int::try_from(line).unwrap_or(std::os::raw::c_int::MIN);
+
+        let message_c_str = filter_str_to_c_string(msg);
+        let filename_c_str = filter_str_to_c_string(filename);
 
         unsafe {
             let logger_raw = self.ptr.as_ref();
@@ -193,3 +194,24 @@ impl Log for UnityRustLogger {
         //no-op
     }
 }
+
+/// Make a nul-terminated UTF8 string by replacing all characters with a NUL
+/// in it with the UTF8 replacement character
+fn filter_str_to_c_string(s: &str) -> CString {
+    if !s.as_bytes().contains(&0) {
+        return CString::new(s).expect("No NUL bytes were detected, check invalid");
+    }
+
+    // A NUL byte was found, reconstruct the string char-by-char
+    let mut tmp_str = String::new();
+
+    for c in s.chars() {
+        if c == '\0' {
+            tmp_str.push(char::REPLACEMENT_CHARACTER);
+        } else {
+            tmp_str.push(c);
+        }
+    }
+
+    CString::new(tmp_str).expect("Reconstructed string was invalid")
+}

unity_native/src/profiler/marker.rs

@@ -156,7 +156,7 @@ impl_from!(f64, Double);
 impl_from!(&'a str, String);
 impl_from!(&'a [u8], Bytes);
 
-impl<'a> MarkerMetaData<'a> {
+impl MarkerMetaData<'_> {
     pub(super) fn to_c_compatible_bytes(self) -> Vec<u8> {
         match self {
             MarkerMetaData::Int32(x) => x.to_ne_bytes().to_vec(),

unity_native/src/profiler/sample.rs

@@ -1,7 +1,7 @@
-use super::marker::MarkerMeta;
-use super::marker::ProfilerMarker;
 use super::EventType;
 use super::UnityProfiler;
+use super::marker::MarkerMeta;
+use super::marker::ProfilerMarker;
 
 #[derive(Debug)]
 pub enum ScopedProfilerSample<'a, 'b, T: MarkerMeta<N>, const N: usize> {
@@ -22,7 +22,7 @@ pub enum ManualProfilerSample<'a, 'b, T: MarkerMeta<N>, const N: usize> {
     },
 }
 
-impl<'a, 'b, T: MarkerMeta<N>, const N: usize> Drop for ScopedProfilerSample<'a, 'b, T, N> {
+impl<T: MarkerMeta<N>, const N: usize> Drop for ScopedProfilerSample<'_, '_, T, N> {
     fn drop(&mut self) {
         match self {
             ScopedProfilerSample::Disabled => {}
@@ -33,7 +33,7 @@ impl<'a, 'b, T: MarkerMeta<N>, const N: usize> Drop for ScopedProfilerSample<'a,
     }
 }
 
-impl<'a, 'b, T: MarkerMeta<N>, const N: usize> ManualProfilerSample<'a, 'b, T, N> {
+impl<T: MarkerMeta<N>, const N: usize> ManualProfilerSample<'_, '_, T, N> {
     pub fn end_sample(&mut self) {
         match self {
             ManualProfilerSample::Disabled => {}
@@ -54,7 +54,7 @@ impl<'a, 'b, T: MarkerMeta<N>, const N: usize> ManualProfilerSample<'a, 'b, T, N
     }
 }
 
-impl<'a, 'b, T: MarkerMeta<N>, const N: usize> Drop for ManualProfilerSample<'a, 'b, T, N> {
+impl<T: MarkerMeta<N>, const N: usize> Drop for ManualProfilerSample<'_, '_, T, N> {
     fn drop(&mut self) {
         if let ManualProfilerSample::Enabled {
             ended,