reifydb_core/encoded/

utf8.rs

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

use std::str;

use reifydb_type::value::r#type::Type;

use crate::encoded::{row::EncodedRow, shape::RowShape};

impl RowShape {
	pub fn set_utf8(&self, row: &mut EncodedRow, index: usize, value: impl AsRef<str>) {
		debug_assert_eq!(*self.fields()[index].constraint.get_type().inner_type(), Type::Utf8);
		self.replace_dynamic_data(row, index, value.as_ref().as_bytes());
	}

	pub fn get_utf8<'a>(&'a self, row: &'a EncodedRow, index: usize) -> &'a str {
		let field = &self.fields()[index];
		debug_assert_eq!(*field.constraint.get_type().inner_type(), Type::Utf8);

		let ref_slice = &row.as_slice()[field.offset as usize..field.offset as usize + 8];
		let offset = u32::from_le_bytes([ref_slice[0], ref_slice[1], ref_slice[2], ref_slice[3]]) as usize;
		let length = u32::from_le_bytes([ref_slice[4], ref_slice[5], ref_slice[6], ref_slice[7]]) as usize;

		let dynamic_start = self.dynamic_section_start();
		let string_start = dynamic_start + offset;
		let string_slice = &row.as_slice()[string_start..string_start + length];

		unsafe { str::from_utf8_unchecked(string_slice) }
	}

	pub fn try_get_utf8<'a>(&'a self, row: &'a EncodedRow, index: usize) -> Option<&'a str> {
		if row.is_defined(index) && self.fields()[index].constraint.get_type() == Type::Utf8 {
			Some(self.get_utf8(row, index))
		} else {
			None
		}
	}
}

#[cfg(test)]
pub mod tests {
	use reifydb_type::value::r#type::Type;

	use crate::encoded::shape::RowShape;

	#[test]
	fn test_set_get_utf8() {
		let shape = RowShape::testing(&[Type::Utf8]);
		let mut row = shape.allocate();
		shape.set_utf8(&mut row, 0, "reifydb");
		assert_eq!(shape.get_utf8(&row, 0), "reifydb");
	}

	#[test]
	fn test_try_get_utf8() {
		let shape = RowShape::testing(&[Type::Utf8]);
		let mut row = shape.allocate();

		assert_eq!(shape.try_get_utf8(&row, 0), None);

		shape.set_utf8(&mut row, 0, "reifydb");
		assert_eq!(shape.try_get_utf8(&row, 0), Some("reifydb"));
	}

	#[test]
	fn test_empty_string() {
		let shape = RowShape::testing(&[Type::Utf8]);
		let mut row = shape.allocate();
		shape.set_utf8(&mut row, 0, "");
		assert_eq!(shape.get_utf8(&row, 0), "");
		assert_eq!(shape.try_get_utf8(&row, 0), Some(""));
	}

	#[test]
	fn test_unicode() {
		let shape = RowShape::testing(&[Type::Utf8]);
		let mut row = shape.allocate();

		let unicode_text = "🚀✨🌟 Hello 世界 🎉";
		shape.set_utf8(&mut row, 0, unicode_text);
		assert_eq!(shape.get_utf8(&row, 0), unicode_text);
		assert_eq!(shape.try_get_utf8(&row, 0), Some(unicode_text));
	}

	#[test]
	fn test_large_string() {
		let shape = RowShape::testing(&[Type::Utf8]);
		let mut row = shape.allocate();

		let large_string = "A".repeat(1000);
		shape.set_utf8(&mut row, 0, &large_string);
		assert_eq!(shape.get_utf8(&row, 0), large_string);
		assert_eq!(shape.try_get_utf8(&row, 0), Some(large_string.as_str()));
	}

	#[test]
	fn test_multiple_fields() {
		let shape = RowShape::testing(&[Type::Utf8, Type::Utf8, Type::Utf8]);
		let mut row = shape.allocate();

		shape.set_utf8(&mut row, 0, "first");
		shape.set_utf8(&mut row, 1, "second string");
		shape.set_utf8(&mut row, 2, "third");

		assert_eq!(shape.get_utf8(&row, 0), "first");
		assert_eq!(shape.get_utf8(&row, 1), "second string");
		assert_eq!(shape.get_utf8(&row, 2), "third");
	}

	#[test]
	fn test_mixed_with_static_fields() {
		let shape = RowShape::testing(&[Type::Boolean, Type::Utf8, Type::Int4, Type::Utf8]);
		let mut row = shape.allocate();

		shape.set_bool(&mut row, 0, true);
		shape.set_utf8(&mut row, 1, "hello world");
		shape.set_i32(&mut row, 2, 42);
		shape.set_utf8(&mut row, 3, "goodbye");

		assert_eq!(shape.get_bool(&row, 0), true);
		assert_eq!(shape.get_utf8(&row, 1), "hello world");
		assert_eq!(shape.get_i32(&row, 2), 42);
		assert_eq!(shape.get_utf8(&row, 3), "goodbye");
	}

	#[test]
	fn test_different_sizes() {
		let shape = RowShape::testing(&[Type::Utf8, Type::Utf8, Type::Utf8]);
		let mut row = shape.allocate();

		shape.set_utf8(&mut row, 0, "");
		shape.set_utf8(&mut row, 1, "medium length string here");
		shape.set_utf8(&mut row, 2, "x");

		assert_eq!(shape.get_utf8(&row, 0), "");
		assert_eq!(shape.get_utf8(&row, 1), "medium length string here");
		assert_eq!(shape.get_utf8(&row, 2), "x");
	}

	#[test]
	fn test_arbitrary_setting_order() {
		let shape = RowShape::testing(&[Type::Utf8, Type::Utf8, Type::Utf8, Type::Utf8]);
		let mut row = shape.allocate();

		// Set in reverse order
		shape.set_utf8(&mut row, 3, "fourth");
		shape.set_utf8(&mut row, 1, "second");
		shape.set_utf8(&mut row, 0, "first");
		shape.set_utf8(&mut row, 2, "third");

		assert_eq!(shape.get_utf8(&row, 0), "first");
		assert_eq!(shape.get_utf8(&row, 1), "second");
		assert_eq!(shape.get_utf8(&row, 2), "third");
		assert_eq!(shape.get_utf8(&row, 3), "fourth");
	}

	#[test]
	fn test_special_characters() {
		let shape = RowShape::testing(&[Type::Utf8]);

		let special_strings = [
			"",
			" ",
			"\n",
			"\t",
			"\r\n",
			"\"quoted\"",
			"'single quotes'",
			"line1\nline2\nline3",
			"tabs\there\tand\there",
			"mixed\twhite\n \r\n\tspace",
		];

		for special_str in special_strings {
			let mut row = shape.allocate();
			shape.set_utf8(&mut row, 0, special_str);
			assert_eq!(shape.get_utf8(&row, 0), special_str);
		}
	}

	#[test]
	fn test_undefined_handling() {
		let shape = RowShape::testing(&[Type::Utf8, Type::Utf8, Type::Utf8]);
		let mut row = shape.allocate();

		// Set only some fields
		shape.set_utf8(&mut row, 0, "defined");
		shape.set_utf8(&mut row, 2, "also defined");

		assert_eq!(shape.try_get_utf8(&row, 0), Some("defined"));
		assert_eq!(shape.try_get_utf8(&row, 1), None);
		assert_eq!(shape.try_get_utf8(&row, 2), Some("also defined"));

		// Set field as undefined
		shape.set_none(&mut row, 0);
		assert_eq!(shape.try_get_utf8(&row, 0), None);
		assert_eq!(shape.try_get_utf8(&row, 2), Some("also defined"));
	}

	#[test]
	fn test_try_get_utf8_wrong_type() {
		let shape = RowShape::testing(&[Type::Boolean]);
		let mut row = shape.allocate();

		shape.set_bool(&mut row, 0, true);

		assert_eq!(shape.try_get_utf8(&row, 0), None);
	}

	#[test]
	fn test_update_utf8() {
		let shape = RowShape::testing(&[Type::Utf8]);
		let mut row = shape.allocate();

		shape.set_utf8(&mut row, 0, "hello");
		assert_eq!(shape.get_utf8(&row, 0), "hello");
		let size_after_first = row.len();

		// Overwrite with shorter string
		shape.set_utf8(&mut row, 0, "hi");
		assert_eq!(shape.get_utf8(&row, 0), "hi");
		assert_eq!(row.len(), size_after_first - 3); // "hello"(5) -> "hi"(2)

		// Overwrite with longer string
		shape.set_utf8(&mut row, 0, "hello world");
		assert_eq!(shape.get_utf8(&row, 0), "hello world");

		// Overwrite with empty string
		shape.set_utf8(&mut row, 0, "");
		assert_eq!(shape.get_utf8(&row, 0), "");
		assert_eq!(row.len(), shape.total_static_size());
	}

	#[test]
	fn test_update_utf8_with_other_dynamic_fields() {
		let shape = RowShape::testing(&[Type::Utf8, Type::Utf8, Type::Utf8]);
		let mut row = shape.allocate();

		shape.set_utf8(&mut row, 0, "first");
		shape.set_utf8(&mut row, 1, "second");
		shape.set_utf8(&mut row, 2, "third");

		// Update middle field with a longer string
		shape.set_utf8(&mut row, 1, "much longer second string");

		// All fields should read correctly
		assert_eq!(shape.get_utf8(&row, 0), "first");
		assert_eq!(shape.get_utf8(&row, 1), "much longer second string");
		assert_eq!(shape.get_utf8(&row, 2), "third");

		// Update first field with shorter string
		shape.set_utf8(&mut row, 0, "f");
		assert_eq!(shape.get_utf8(&row, 0), "f");
		assert_eq!(shape.get_utf8(&row, 1), "much longer second string");
		assert_eq!(shape.get_utf8(&row, 2), "third");

		// No orphan data: total size = static + sum of current strings
		let expected = shape.total_static_size() + 1 + 25 + 5;
		assert_eq!(row.len(), expected);
	}
}