mirrors/bun.sh
1
0
Fork 0
mirror of https://github.com/oven-sh/bun synced 2026-02-09 10:28:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Remove subjective claims from zero() method documentation

Browse Source 
Focus on what the function does rather than why it should be used.
Remove context-dependent claims about efficiency, security, and use cases.
This commit is contained in:
Claude Bot
2025-07-30 21:21:41 +00:00
parent 76bf2a6ac0
commit 66c018c698
1 changed files with 3 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/collections/multi_array_list.zig
View File

@@ -605,17 +605,9 @@ pub fn MultiArrayList(comptime T: type) type {
/// Zero-initialize all allocated memory in the MultiArrayList.
///
/// This method efficiently clears the entire backing buffer by setting all bytes to zero,
/// which zero-initializes all fields across all elements in the list. This is more
/// efficient than iterating through individual elements or fields.
///
/// Use cases:
/// - Security: Clear sensitive data from memory
/// - Deterministic behavior: Ensure uninitialized memory doesn't contain garbage
/// - Testing: Create predictable initial states
///
/// Note: This operation affects the entire allocated capacity, not just the current length.
/// All reserved but unused capacity will also be zeroed.
/// Sets all bytes in the backing buffer to zero, which zero-initializes all fields
/// across all elements in the list. This operation affects the entire allocated
/// capacity, not just the current length.
pub fn zero(self: Self) void {
@memset(self.allocatedBytes(), 0);
}