Skip to content

Commit

Permalink
Merge pull request #197 from c410-f3r/str
Browse files Browse the repository at this point in the history
Add `zero_filled` constructor
  • Loading branch information
bluss committed Aug 14, 2021
2 parents e5b3c9b + 1e74077 commit e209a50
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
22 changes: 22 additions & 0 deletions src/array_string.rs
Expand Up @@ -129,6 +129,28 @@ impl<const CAP: usize> ArrayString<CAP>
Ok(vec)
}

/// Create a new `ArrayString` value fully filled with ASCII NULL characters (`\0`). Useful
/// to be used as a buffer to collect external data or as a buffer for intermediate processing.
///
/// ```
/// use arrayvec::ArrayString;
///
/// let string = ArrayString::<16>::zero_filled();
/// assert_eq!(string.len(), 16);
/// ```
#[inline]
pub fn zero_filled() -> Self {
assert_capacity_limit!(CAP);
// SAFETY: `assert_capacity_limit` asserts that `len` won't overflow and
// `zeroed` fully fills the array with nulls.
unsafe {
ArrayString {
xs: MaybeUninit::zeroed().assume_init(),
len: CAP as _
}
}
}

/// Return the capacity of the `ArrayString`.
///
/// ```
Expand Down
7 changes: 6 additions & 1 deletion tests/tests.rs
Expand Up @@ -773,7 +773,6 @@ fn test_arrayvec_const_constructible() {
assert_eq!(var[..], [vec![3, 5, 8]]);
}


#[test]
fn test_arraystring_const_constructible() {
const AS: ArrayString<10> = ArrayString::new_const();
Expand All @@ -786,3 +785,9 @@ fn test_arraystring_const_constructible() {
}


#[test]
fn test_arraystring_zero_filled_has_some_sanity_checks() {
let string = ArrayString::<4>::zero_filled();
assert_eq!(string.as_str(), "\0\0\0\0");
assert_eq!(string.len(), 4);
}

0 comments on commit e209a50

Please sign in to comment.