1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
use core::char::{decode_utf16, REPLACEMENT_CHARACTER};
use core::ops::{Bound, RangeBounds};
use core::str::{
self, from_utf8, from_utf8_unchecked,
pattern::{Pattern, Searcher},
};
pub use self::string_errors::StringError;
use self::string_utils::{
encode_char_utf8_unchecked, is_char_boundary, is_inside_boundary, never, shift_left_unchecked,
shift_right_unchecked, str_is_char_boundary, truncate_str,
};
use crate::errors::CapacityError;
use crate::StaticVec;
#[cfg(all(feature = "std", rustdoc))]
use alloc::string::String;
mod string_errors;
mod string_trait_impls;
#[macro_use]
mod string_utils;
/// A fixed-capacity [`String`](alloc::string::String)-like struct built around an instance of
/// `StaticVec<u8, N>`.
///
/// ## Examples
///
/// ```
/// use staticvec::{StaticString, StringError};
///
/// #[derive(Debug)]
/// pub struct User {
/// pub username: StaticString<20>,
/// pub role: StaticString<5>,
/// }
///
/// fn main() -> Result<(), StringError> {
/// let user = User {
/// username: StaticString::try_from_str("user")?,
/// role: StaticString::try_from_str("admin")?,
/// };
/// println!("{:?}", user);
/// Ok(())
/// }
/// ```
pub struct StaticString<const N: usize> {
pub(crate) vec: StaticVec<u8, N>,
}
impl<const N: usize> StaticString<N> {
/// Returns a new StaticString instance.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let string = StaticString::<20>::new();
/// assert!(string.is_empty());
/// ```
#[inline(always)]
pub const fn new() -> Self {
Self {
vec: StaticVec::new(),
}
}
/// An internal "const constructor" helper function that exists to support the `staticstring!`
/// macro. This is only used in one place at the moment, where the input `StaticVec` is known to
/// have been built from a valid-UTF8 `&'static str` literal. Since this has to be accessible from
/// the macro when invoked from external crates, and so can't be `pub(crate)`, we hide it from the
/// docs and give it a two-underscore prefix as the next best thing.
#[doc(hidden)]
#[inline(always)]
pub const unsafe fn __new_from_staticvec(vec: StaticVec<u8, N>) -> Self {
Self { vec }
}
/// Creates a new StaticString instance from `string`, without doing any checking to ensure that
/// the length of `string` does not exceed the resulting StaticString's declared capacity.
///
/// # Safety
///
/// The length of `string` must not exceed the declared capacity of the StaticString being
/// created, as this would result in writing to an out-of-bounds memory region.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let string = unsafe { StaticString::<20>::from_str_unchecked("My String") };
/// assert_eq!(string, "My String");
/// ```
#[inline(always)]
pub const unsafe fn from_str_unchecked(string: &str) -> Self {
let mut res = Self::new();
res.push_str_unchecked(string);
res
}
/// Creates a new StaticString from `string`, truncating `string` as necessary if it has
/// a length greater than the StaticString's declared capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let string = StaticString::<20>::from_str("My String");
/// assert_eq!(string, "My String");
/// let truncate = "0".repeat(21);
/// let truncated = "0".repeat(20);
/// let string = StaticString::<20>::from_str(&truncate);
/// assert_eq!(string, truncated.as_str());
/// ```
#[allow(clippy::should_implement_trait)]
#[inline(always)]
pub fn from_str<S: AsRef<str>>(string: S) -> Self {
let mut res = Self::new();
let string_ref = string.as_ref();
unsafe {
match string_ref.len() <= N {
false => res.push_str_unchecked(truncate_str(string_ref, N)),
true => res.push_str_unchecked(string_ref),
}
}
res
}
/// Creates a new StaticString from `string` if the length of `string` is less than or equal
/// to the StaticString's declared capacity, or returns a
/// [`CapacityError`](crate::errors::CapacityError) otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let string = StaticString::<20>::from("My String");
/// assert_eq!(string.as_str(), "My String");
/// assert_eq!(StaticString::<20>::try_from_str("").unwrap().as_str(), "");
/// let out_of_bounds = "0".repeat(21);
/// assert!(StaticString::<20>::try_from_str(out_of_bounds).is_err());
/// ```
#[inline(always)]
pub fn try_from_str<S: AsRef<str>>(string: S) -> Result<Self, CapacityError<N>> {
let mut res = Self::new();
res.try_push_str(string)?;
Ok(res)
}
/// Creates a new StaticString from the contents of an iterator, returning immediately if and when
/// the StaticString reaches maximum capacity regardless of whether or not the iterator still has
/// more items to yield.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let string = StaticString::<300>::from_iterator(&["My String", " Other String"][..]);
/// assert_eq!(string.as_str(), "My String Other String");
/// let out_of_bounds = (0..400).map(|_| "000");
/// let truncated = "0".repeat(18);
/// let truncate = StaticString::<20>::from_iterator(out_of_bounds);
/// assert_eq!(truncate.as_str(), truncated.as_str());
/// # Ok(())
/// # }
/// ```
#[inline]
pub fn from_iterator<U: AsRef<str>, I: IntoIterator<Item = U>>(iter: I) -> Self {
let mut res = Self::new();
for s in iter {
let s_ref = s.as_ref();
match res.remaining_capacity() < s_ref.len() {
false => unsafe { res.push_str_unchecked(s_ref) },
true => break,
}
}
res
}
/// Creates a new StaticString from the contents of an iterator if the iterator has a length less
/// than or equal to the StaticString's declared capacity, or returns a
/// [`CapacityError`](crate::errors::CapacityError) otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let string = StaticString::<300>::try_from_iterator(
/// &["My String", " My Other String"][..]
/// ).unwrap();
/// assert_eq!(string.as_str(), "My String My Other String");
/// let out_of_bounds = (0..100).map(|_| "000");
/// assert!(StaticString::<20>::try_from_iterator(out_of_bounds).is_err());
/// ```
#[inline]
pub fn try_from_iterator<U: AsRef<str>, I: IntoIterator<Item = U>>(
iter: I,
) -> Result<Self, CapacityError<N>> {
let mut res = Self::new();
for s in iter {
res.try_push_str(s)?;
}
Ok(res)
}
/// Creates a new StaticString from the contents of a `char` iterator, returning immediately if
/// and when the StaticString reaches maximum capacity regardless of whether or not the iterator
/// still has more items to yield.
///
/// ```
/// # use staticvec::StaticString;
/// let string = StaticString::<20>::from_chars("My String".chars());
/// assert_eq!(string, "My String");
/// let out_of_bounds = "0".repeat(21);
/// let truncated = "0".repeat(20);
/// let truncate = StaticString::<20>::from_chars(out_of_bounds.chars());
/// assert_eq!(truncate.as_str(), truncated.as_str());
/// ```
#[inline]
pub fn from_chars<I: IntoIterator<Item = char>>(iter: I) -> Self {
let mut res = Self::new();
for c in iter {
match res.remaining_capacity() < c.len_utf8() {
false => unsafe { res.push_unchecked(c) },
true => break,
}
}
res
}
/// Creates a new StaticString from the contents of a `char` iterator if the iterator has a length
/// less than or equal to the StaticString's declared capacity, or returns
/// [`StringError::OutOfBounds`] otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let string = StaticString::<20>::try_from_chars("My String".chars())?;
/// assert_eq!(string.as_str(), "My String");
/// let out_of_bounds = "0".repeat(21);
/// assert!(StaticString::<20>::try_from_chars(out_of_bounds.chars()).is_err());
/// # Ok(())
/// # }
/// ```
#[inline]
pub fn try_from_chars<I: IntoIterator<Item = char>>(iter: I) -> Result<Self, StringError> {
let mut res = Self::new();
for c in iter {
res.try_push(c)?;
}
Ok(res)
}
/// Creates a new StaticString instance from the provided byte slice, without doing any checking
/// to ensure that the slice contains valid UTF-8 data and has a length less than or equal to
/// the declared capacity of the StaticString.
///
/// # Safety
///
/// The length of the slice must not exceed the declared capacity of the StaticString being
/// created, as this would result in writing to an out-of-bounds memory region.
///
/// The slice must also contain strictly valid UTF-8 data, as if it does not, various assumptions
/// made in the internal implementation of StaticString will be silently invalidated, almost
/// certainly eventually resulting in undefined behavior.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let string = unsafe { StaticString::<20>::from_utf8_unchecked("My String") };
/// assert_eq!(string, "My String");
/// // Undefined behavior, don't do it:
/// // let out_of_bounds = "0".repeat(300);
/// // let ub = unsafe { StaticString::<20>::from_utf8_unchecked(out_of_bounds)) };
/// ```
#[inline(always)]
pub unsafe fn from_utf8_unchecked<B: AsRef<[u8]>>(slice: B) -> Self {
debug_assert!(from_utf8(slice.as_ref()).is_ok());
Self::from_str_unchecked(from_utf8_unchecked(slice.as_ref()))
}
/// Creates a new StaticString instance from the provided byte slice, returning
/// [`StringError::Utf8`] on invalid UTF-8 data, and truncating the input slice as necessary if
/// it has a length greater than the declared capacity of the StaticString being created.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let string = StaticString::<20>::from_utf8("My String")?;
/// assert_eq!(string, "My String");
/// let invalid_utf8 = [0, 159, 146, 150];
/// assert!(StaticString::<20>::from_utf8(invalid_utf8).unwrap_err().is_utf8());
/// let out_of_bounds = "0".repeat(300);
/// assert_eq!(StaticString::<20>::from_utf8(out_of_bounds.as_bytes())?.as_str(), "0".repeat(20).as_str());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub fn from_utf8<B: AsRef<[u8]>>(slice: B) -> Result<Self, StringError> {
Ok(Self::from_str(from_utf8(slice.as_ref())?))
}
/// Creates a new StaticString from the provided byte slice, returning [`StringError::Utf8`] on
/// invalid UTF-8 data or [`StringError::OutOfBounds`] if the slice has a length greater than
/// the StaticString's declared capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let string = StaticString::<20>::try_from_utf8("My String")?;
/// assert_eq!(string, "My String");
/// let invalid_utf8 = [0, 159, 146, 150];
/// assert!(StaticString::<20>::try_from_utf8(invalid_utf8).unwrap_err().is_utf8());
/// let out_of_bounds = "0000".repeat(400);
/// assert!(StaticString::<20>::try_from_utf8(out_of_bounds.as_bytes()).unwrap_err().is_out_of_bounds());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub fn try_from_utf8<B: AsRef<[u8]>>(slice: B) -> Result<Self, StringError> {
Ok(Self::try_from_str(from_utf8(slice.as_ref())?)?)
}
/// Creates a new StaticString instance from the provided `u16` slice, replacing invalid UTF-16
/// data with `REPLACEMENT_CHARACTER` (�), and truncating the input slice as necessary if
/// it has a length greater than the declared capacity of the StaticString being created.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let music = [0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063];
/// let string = StaticString::<20>::from_utf16_lossy(music);
/// assert_eq!(string, "𝄞music");
/// let invalid_utf16 = [0xD834, 0xDD1E, 0x006d, 0x0075, 0xD800, 0x0069, 0x0063];
/// assert_eq!(StaticString::<20>::from_utf16_lossy(invalid_utf16).as_str(), "𝄞mu\u{FFFD}ic");
/// let out_of_bounds: Vec<u16> = (0..300).map(|_| 0).collect();
/// assert_eq!(StaticString::<20>::from_utf16_lossy(&out_of_bounds).as_str(), "\0".repeat(20).as_str());
/// ```
#[inline(always)]
pub fn from_utf16_lossy<B: AsRef<[u16]>>(slice: B) -> Self {
let mut res = Self::new();
for c in decode_utf16(slice.as_ref().iter().copied()) {
if res.try_push(c.unwrap_or(REPLACEMENT_CHARACTER)).is_err() {
break;
}
}
res
}
/// Creates a new StaticString instance from the provided `u16` slice, returning
/// [`StringError::Utf16`] on invalid UTF-16 data, and truncating the input slice as necessary if
/// it has a length greater than the declared capacity of the StaticString being created.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let music = [0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063];
/// let string = StaticString::<20>::from_utf16(music)?;
/// assert_eq!(string.as_str(), "𝄞music");
/// let invalid_utf16 = [0xD834, 0xDD1E, 0x006d, 0x0075, 0xD800, 0x0069, 0x0063];
/// assert!(StaticString::<20>::from_utf16(invalid_utf16).unwrap_err().is_utf16());
/// let out_of_bounds: Vec<u16> = (0..300).map(|_| 0).collect();
/// assert_eq!(StaticString::<20>::from_utf16(out_of_bounds)?.as_str(),
/// "\0".repeat(20).as_str());
/// # Ok(())
/// # }
/// ```
#[inline]
pub fn from_utf16<B: AsRef<[u16]>>(slice: B) -> Result<Self, StringError> {
let mut res = Self::new();
for c in decode_utf16(slice.as_ref().iter().copied()) {
if res.try_push(c?).is_err() {
break;
}
}
Ok(res)
}
/// Creates a new StaticString from the provided `u16` slice, returning [`StringError::Utf16`] on
/// invalid UTF-16 data or [`StringError::OutOfBounds`] if the slice has a length greater than the
/// declared capacity of the StaticString being created.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticVec, StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let music = [0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063];
/// let string = StaticString::<20>::try_from_utf16(music)?;
/// assert_eq!(string.as_str(), "𝄞music");
/// let invalid_utf16 = [0xD834, 0xDD1E, 0x006d, 0x0075, 0xD800, 0x0069, 0x0063];
/// assert!(StaticString::<20>::try_from_utf16(invalid_utf16).unwrap_err().is_utf16());
/// let out_of_bounds: StaticVec<u16, 300> = (0..300).map(|_| 0).collect();
/// assert!(StaticString::<20>::try_from_utf16(out_of_bounds).unwrap_err().is_out_of_bounds());
/// # Ok(())
/// # }
/// ```
#[inline]
pub fn try_from_utf16<B: AsRef<[u16]>>(slice: B) -> Result<Self, StringError> {
let mut res = Self::new();
for c in decode_utf16(slice.as_ref().iter().copied()) {
res.try_push(c?)?;
}
Ok(res)
}
/// Extracts a `str` slice containing the entire contents of the StaticString.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let s = StaticString::<20>::from_str("My String");
/// assert_eq!(s.as_str(), "My String");
/// ```
#[inline(always)]
pub const fn as_str(&self) -> &str {
unsafe { &*(self.as_bytes() as *const [u8] as *const str) }
}
/// Extracts a mutable `str` slice containing the entire contents of the StaticString.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut s = StaticString::<20>::from_str("My String");
/// assert_eq!(s.as_mut_str(), "My String");
/// ```
#[inline(always)]
pub const fn as_mut_str(&mut self) -> &mut str {
unsafe { &mut *(self.as_mut_bytes() as *mut [u8] as *mut str) }
}
/// Extracts a `u8` slice containing the entire contents of the StaticString.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let s = StaticString::<20>::from_str("My String");
/// assert_eq!(s.as_bytes(), "My String".as_bytes());
/// ```
#[inline(always)]
pub const fn as_bytes(&self) -> &[u8] {
self.vec.as_slice()
}
/// Returns the StaticString's internal instance of `StaticVec<u8, N>`.
/// Note that using this function consumes the StaticString.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let s = StaticString::<5>::from("hello");
/// let bytes = s.into_bytes();
/// assert_eq!(&bytes[..], &[104, 101, 108, 108, 111][..]);
/// ```
#[inline(always)]
pub fn into_bytes(self) -> StaticVec<u8, N> {
self.vec
}
/// Extracts a mutable `u8` slice containing the entire contents of the StaticString.
///
/// # Safety
///
/// Care must be taken to ensure that the returned `u8` slice is not mutated in such a way that
/// it no longer amounts to valid UTF-8.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = StaticString::<20>::try_from_str("My String")?;
/// assert_eq!(unsafe { s.as_mut_bytes() }, "My String".as_bytes());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub const unsafe fn as_mut_bytes(&mut self) -> &mut [u8] {
self.vec.as_mut_slice()
}
/// Returns a mutable reference to the StaticString's backing StaticVec.
///
/// # Safety
///
/// Care must be taken to ensure that the returned StaticVec reference is not mutated in such a
/// way that it no longer contains valid UTF-8.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = StaticString::<20>::try_from_str("My String")?;
/// assert_eq!(unsafe { s.as_mut_staticvec() }, "My String".as_bytes());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub const unsafe fn as_mut_staticvec(&mut self) -> &mut StaticVec<u8, N> {
&mut self.vec
}
/// Returns the total capacity of the StaticString.
/// This is always equivalent to the generic `N` parameter it was declared with,
/// which determines the fixed size of the backing StaticVec instance.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// assert_eq!(StaticString::<32>::new().capacity(), 32);
/// ```
#[inline(always)]
pub const fn capacity(&self) -> usize {
self.vec.capacity()
}
/// Returns the remaining capacity (which is to say, `self.capacity() - self.len()`) of the
/// StaticString.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// assert_eq!(StaticString::<32>::from("abcd").remaining_capacity(), 28);
/// ```
#[inline(always)]
pub const fn remaining_capacity(&self) -> usize {
self.vec.remaining_capacity()
}
/// Pushes `string` to the StaticString without doing any checking to ensure that `self.len() +
/// string.len()` does not exceed the StaticString's total capacity.
///
/// # Safety
///
/// `self.len() + string.len()` must not exceed the total capacity of the StaticString
/// instance, as this would result in writing to an out-of-bounds memory region.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString};
/// let mut s = StaticString::<6>::from("foo");
/// unsafe { s.push_str_unchecked("bar") };
/// assert_eq!(s, "foobar");
/// ```
#[inline(always)]
pub const unsafe fn push_str_unchecked(&mut self, string: &str) {
let string_length = string.len();
debug_assert!(string_length <= self.remaining_capacity());
let old_length = self.len();
push_str_unchecked_internal!(self, string, old_length, string_length);
}
/// Attempts to push `string` to the StaticString, panicking if it is the case that `self.len() +
/// string.len()` exceeds the StaticString's total capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString};
/// let mut s = StaticString::<6>::from("foo");
/// s.push_str("bar");
/// assert_eq!(s, "foobar");
/// ```
#[inline]
pub fn push_str<S: AsRef<str>>(&mut self, string: S) {
// Note that when calling this at runtime, the compiler still just sees the signature
// as `push_str<S: AsRef<str>>(&mut self, string: S)`. Adding new `~const` bounds is only
// a "breaking change" if you add them to something that was *already* a `const fn`. Adding
// them while turning something *into* a `const fn` is fully backwards compatible, though.
let string_ref = string.as_ref();
let string_length = string_ref.len();
let old_length = self.vec.length;
assert!(
string_length <= N - old_length,
"Insufficient remaining capacity!"
);
push_str_unchecked_internal!(self, string_ref, old_length, string_length);
}
/// Attempts to push `string` to the StaticString. Truncates `string` as necessary (or simply does
/// nothing at all) if it is the case that `self.len() + string.len()` exceeds the
/// StaticString's total capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = StaticString::<300>::try_from_str("My String")?;
/// s.push_str_truncating(" My other String");
/// assert_eq!(s.as_str(), "My String My other String");
/// let mut s = StaticString::<20>::new();
/// s.push_str_truncating("0".repeat(21));
/// assert_eq!(s.as_str(), "0".repeat(20).as_str());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub fn push_str_truncating<S: AsRef<str>>(&mut self, string: S) {
unsafe { self.push_str_unchecked(truncate_str(string.as_ref(), self.remaining_capacity())) };
}
/// Pushes `string` to the StaticString if `self.len() + string.len()` does not exceed
/// the StaticString's total capacity, or returns a
/// [`CapacityError`](crate::errors::CapacityError) otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut s = StaticString::<300>::from("My String");
/// s.try_push_str(" My other String").unwrap();
/// assert_eq!(s.as_str(), "My String My other String");
/// assert!(s.try_push_str("0".repeat(300)).is_err());
/// ```
#[inline(always)]
pub fn try_push_str<S: AsRef<str>>(&mut self, string: S) -> Result<(), CapacityError<N>> {
let string_ref = string.as_ref();
let string_length = string_ref.len();
let old_length = self.vec.length;
if N - old_length < string_length {
Err(CapacityError {})
} else {
push_str_unchecked_internal!(self, string_ref, old_length, string_length);
Ok(())
}
}
/// Appends the given char to the end of the StaticString without doing any checking to ensure
/// that `self.len() + character.len_utf8()` does not exceed the total capacity of the
/// StaticString instance.
///
/// # Safety
///
/// `self.len() + character.len_utf8()` must not exceed the total capacity of the StaticString
/// instance, as this would result in writing to an out-of-bounds memory region.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = StaticString::<20>::try_from_str("My String")?;
/// unsafe { s.push_unchecked('!') };
/// assert_eq!(s.as_str(), "My String!");
/// // Undefined behavior, don't do it:
/// // s = StaticString::<20>::try_from_str(&"0".repeat(20))?;
/// // s.push_unchecked('!');
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub const unsafe fn push_unchecked(&mut self, character: char) {
let char_len = character.len_utf8();
push_char_unchecked_internal!(self, character as u32, char_len);
}
/// Appends the given char to the end of the StaticString, panicking if the StaticString
/// is already at maximum capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// let mut string = StaticString::<2>::new();
/// string.push('a');
/// string.push('b');
/// assert_eq!(&string[..], "ab");
/// ```
#[inline(always)]
pub const fn push(&mut self, character: char) {
let char_len = character.len_utf8();
assert!(
char_len <= self.remaining_capacity(),
"Insufficient remaining capacity!"
);
push_char_unchecked_internal!(self, character as u32, char_len);
}
/// Appends the given char to the end of the StaticString, returning [`StringError::OutOfBounds`]
/// if the StaticString is already at maximum capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = StaticString::<20>::try_from_str("My String")?;
/// s.try_push('!')?;
/// assert_eq!(s.as_str(), "My String!");
/// let mut s = StaticString::<20>::try_from_str(&"0".repeat(20))?;
/// assert!(s.try_push('!').is_err());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub const fn try_push(&mut self, character: char) -> Result<(), StringError> {
let char_len = character.len_utf8();
match self.remaining_capacity() < char_len {
false => {
push_char_unchecked_internal!(self, character as u32, char_len);
Ok(())
}
true => Err(StringError::OutOfBounds),
}
}
/// Truncates the StaticString to `new_len` if `new_len` is less than or equal to the
/// StaticString's current length, or does nothing otherwise. Panics if `new_len` does not lie
/// at a valid UTF-8 character boundary.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut s = StaticString::<20>::from("My String");
/// s.truncate(5);
/// assert_eq!(s, "My St");
/// // Does nothing
/// s.truncate(6);
/// assert_eq!(s, "My St");
/// // Would panic
/// // let mut s2 = StaticString::<20>::from("🤔");
/// // s2.truncate(1);
/// ```
#[inline(always)]
pub const fn truncate(&mut self, new_len: usize) {
if new_len <= self.len() {
assert!(str_is_char_boundary(self, new_len));
unsafe { self.vec.set_len(new_len) };
}
}
/// Returns the last character in the StaticString in `Some` if the StaticString's current length
/// is greater than zero, or `None` otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = StaticString::<20>::try_from_str("A🤔")?;
/// assert_eq!(s.pop(), Some('🤔'));
/// assert_eq!(s.pop(), Some('A'));
/// assert_eq!(s.pop(), None);
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub fn pop(&mut self) -> Option<char> {
self.as_str().chars().last().map(|character| {
unsafe { self.vec.set_len(self.len() - character.len_utf8()) };
character
})
}
/// Removes all whitespace from the beginning and end of the StaticString, if any is present.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut string = StaticString::<300>::try_from_str(" to be trimmed ")?;
/// string.trim();
/// assert_eq!(string.as_str(), "to be trimmed");
/// let mut string = StaticString::<20>::try_from_str(" 🤔")?;
/// string.trim();
/// assert_eq!(string.as_str(), "🤔");
/// # Ok(())
/// # }
/// ```
#[inline]
pub fn trim(&mut self) {
let is_whitespace = |bytes: &[u8], index: usize| {
debug_assert!(index < bytes.len());
unsafe { bytes.get_unchecked(index) == &b' ' }
};
let (mut start, mut end, mut leave) = (0_usize, self.len(), 0_usize);
while start < end && leave < 2 {
leave = 0;
if is_whitespace(self.as_bytes(), start) {
start += 1;
if start >= end {
continue;
};
} else {
leave += 1;
}
if start < end && is_whitespace(self.as_bytes(), end - 1) {
end -= 1;
} else {
leave += 1;
}
}
unsafe {
shift_left_unchecked(self, start, 0usize);
self.vec.set_len(end - start)
};
}
/// Removes the char at `index` from the StaticString if `index` is both less than `self.len()`
/// and also lies at a valid UTF-8 character boundary, or panics otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut s = StaticString::<20>::from("ABCD🤔");
/// assert_eq!(s.remove(0), 'A');
/// assert!(s == "BCD🤔");
/// assert_eq!(s.remove(2), 'D');
/// assert!(s == "BC🤔");
/// ```
#[inline]
pub fn remove(&mut self, index: usize) -> char {
assert!(
self.as_str().is_char_boundary(index),
"Out of bounds or invalid character boundary!"
);
let old_length = self.len();
let character = unsafe { self.as_str().get_unchecked(index..).chars().next() };
let character = character.unwrap_or_else(|| unsafe { never("Missing char") });
let char_length = character.len_utf8();
unsafe {
shift_left_unchecked(self, index + char_length, index);
self.vec.set_len(old_length - char_length);
}
character
}
/// Removes all matches of pattern `pat` in the `StaticString`.
///
/// # Example usage:
/// ```
/// # use staticvec::{staticstring, StaticString};
/// let mut s = staticstring!("Trees are not green, the sky is not blue.");
/// s.remove_matches("not ");
/// assert_eq!("Trees are green, the sky is blue.", s.as_str());
/// ```
///
/// Matches will be detected and removed iteratively, so in cases where
/// patterns overlap, only the first pattern will be removed:
///
/// ```
/// # use staticvec::{staticstring, StaticString};
/// let mut s = staticstring!("banana");
/// s.remove_matches("ana");
/// assert_eq!("bna", s.as_str());
/// ```
#[inline]
pub fn remove_matches<'a, P: for<'x> Pattern<'x>>(&'a mut self, pat: P) {
let old_length = self.len();
if old_length == 0 {
return;
}
let mut matches = StaticVec::<(usize, usize), N>::new();
// Create `searcher` in a scope, so that it's dropped exactly when we want.
{
let mut searcher = pat.into_searcher(self);
while let Some(m) = searcher.next_match() {
// Safety: it is not possible for the number of matches to be greater than 'N', because
// 'N' is the number of individual bytes that the `StaticString` this function is being
// called through has guaranteed capacity for.
unsafe {
matches.push_unchecked(m);
}
}
}
let mut shrunk_by = 0;
let vec_ptr = self.vec.as_mut_ptr();
for (start, end) in &matches {
// Safety: `start` and `end` will be on UTF-8 byte boundaries per the `Searcher` docs.
unsafe {
vec_ptr
.add(end - shrunk_by)
.copy_to(vec_ptr.add(start - shrunk_by), old_length - end);
}
shrunk_by += end - start;
}
unsafe {
self.vec.set_len(old_length - shrunk_by);
}
}
/// Removes all characters from the StaticString except for those specified by the predicate
/// function.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut s = StaticString::<20>::from("ABCD🤔");
/// s.retain(|c| c != '🤔');
/// assert_eq!(s, "ABCD");
/// ```
#[inline(always)]
pub fn retain<F: FnMut(char) -> bool>(&mut self, mut f: F) {
// Having benched `retain` implemented both this way and exactly how `std::string::String`
// does, this way is faster believe it or not.
*self = Self::from_chars(self.as_str().chars().filter(|c| f(*c)));
}
/// Inserts `character` at `index`, shifting any values that exist in positions greater than
/// `index` to the right.
///
/// Does not do any checking to ensure that `character.len_utf8() + self.len()` does not exceed
/// the total capacity of the StaticString or that `index` lies at a valid UTF-8 character
/// boundary.
///
/// # Safety
///
/// The length of the StaticString prior to calling this function must be less than its total
/// capacity, as if this in not the case it will result in writing to an out-of-bounds memory
/// region.
///
/// `Index` must also lie at a valid UTF-8 character boundary, as if it does not, various
/// assumptions made in the internal implementation of StaticString will be silently
/// invalidated, almost certainly eventually resulting in undefined behavior.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = StaticString::<20>::try_from_str("ABCD🤔")?;
/// unsafe { s.insert_unchecked(1, 'A') };
/// unsafe { s.insert_unchecked(1, 'B') };
/// assert_eq!(s.as_str(), "ABABCD🤔");
/// // Undefined behavior, don't do it:
/// // s.insert(20, 'C');
/// // s.insert(8, 'D');
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub unsafe fn insert_unchecked(&mut self, index: usize, character: char) {
let char_length = character.len_utf8();
shift_right_unchecked(self, index, index + char_length);
encode_char_utf8_unchecked(self, character, index);
}
/// Inserts `character` at `index`, shifting any values that exist in positions greater than
/// `index` to the right.
///
/// Returns [`StringError::OutOfBounds`] if `character.len_utf8() + self.len()` exceeds the total
/// capacity of the StaticString and [`StringError::NotCharBoundary`] if `index` does not lie at
/// a valid UTF-8 character boundary.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = StaticString::<20>::try_from_str("ABCD🤔")?;
/// s.try_insert(1, 'E')?;
/// s.try_insert(2, 'F')?;
/// assert_eq!(s.as_str(), "AEFBCD🤔");
/// assert!(s.try_insert(20, 'C').unwrap_err().is_not_char_boundary());
/// assert!(s.try_insert(8, 'D').unwrap_err().is_not_char_boundary());
/// let mut s = StaticString::<20>::try_from_str(&"0".repeat(20))?;
/// assert!(s.try_insert(0, 'C').unwrap_err().is_out_of_bounds());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub fn try_insert(&mut self, index: usize, character: char) -> Result<(), StringError> {
is_inside_boundary(character.len_utf8() + self.len(), N)?;
is_char_boundary(self, index)?;
unsafe { self.insert_unchecked(index, character) };
Ok(())
}
/// Inserts `character` at `index`, shifting any values that exist in positions greater than
/// `index` to the right.
///
/// Panics if `character.len_utf8() + self.len()` exceeds the total capacity of the StaticString
/// or if `index` does not lie at a valid UTF-8 character boundary.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString};
/// let mut s = StaticString::<3>::new();
/// s.insert(0, 'f');
/// s.insert(1, 'o');
/// s.insert(2, 'o');
/// assert_eq!(s, "foo");
/// ```
#[inline(always)]
pub fn insert(&mut self, index: usize, character: char) {
self.try_insert(index, character).unwrap();
}
/// Inserts `string` at `index`, shifting any values that exist in positions greater than
/// `index` to the right.
///
/// Does not do any checking to ensure that `self.len() + string.len()` does not exceed
/// the total capacity of the StaticString or that `index` lies at a valid UTF-8
/// character boundary.
///
/// # Safety
///
/// `self.len() + string.len()` must not exceed the total capacity of the StaticString instance,
/// as this would result in writing to an out-of-bounds memory region.
///
/// `Index` must also lie at a valid UTF-8 character boundary, as if it does not, various
/// assumptions made in the internal implementation of StaticString will be silently
/// invalidated, almost certainly eventually resulting in undefined behavior.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut s = StaticString::<20>::from_str("ABCD🤔");
/// unsafe { s.insert_str_unchecked(1, "AB") };
/// unsafe { s.insert_str_unchecked(1, "BC") };
/// assert_eq!(s, "ABCABBCD🤔");
/// // Undefined behavior, don't do it:
/// // unsafe { s.insert_str_unchecked(20, "C") };
/// // unsafe { s.insert_str_unchecked(10, "D") };
/// // unsafe { s.insert_str_unchecked(1, "0".repeat(20)) };
/// ```
#[inline]
pub unsafe fn insert_str_unchecked<S: AsRef<str>>(&mut self, index: usize, string: S) {
let string_ref = string.as_ref();
let string_length = string_ref.len();
debug_assert!(string_length <= self.remaining_capacity());
let string_ptr = string_ref.as_ptr();
shift_right_unchecked(self, index, index + string_length);
string_ptr.copy_to_nonoverlapping(self.vec.mut_ptr_at_unchecked(index), string_length);
self.vec.set_len(self.len() + string_length);
}
/// Inserts `string` at `index`, shifting any values that exist in positions greater than
/// `index` to the right.
///
/// Panics if `index` is greater than the length of the StaticString or if it does not lie
/// at a valid UTF-8 character boundary, as well as if `string.len() + self.len()` exceeds
/// the total capacity of the StaticString.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut s = StaticString::<20>::from("ABCD🤔");
/// s.insert_str(1, "AB");
/// s.insert_str(1, "BC");
/// assert_eq!(s.as_str(), "ABCABBCD🤔");
/// ```
#[inline(always)]
pub fn insert_str<S: AsRef<str>>(&mut self, index: usize, string: S) {
let string_ref = string.as_ref();
let string_length = string_ref.len();
assert!(
string_length <= self.remaining_capacity() && self.as_str().is_char_boundary(index),
"Insufficient remaining capacity or invalid character boundary!"
);
unsafe { self.insert_str_unchecked(index, string_ref) };
}
/// Inserts `string` at `index`, shifting any values that exist in positions greater than
/// `index` to the right.
///
/// Returns [`StringError::OutOfBounds`] if `self.len() + string.len()` exceeds the total
/// capacity of the StaticString and [`StringError::NotCharBoundary`] if `index` does not
/// lie at a valid UTF-8 character boundary.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut string = StaticString::<20>::try_from_str("ABCD🤔")?;
/// string.try_insert_str(1, "AB")?;
/// string.try_insert_str(1, "BC")?;
/// assert!(string.try_insert_str(1, "0".repeat(20)).unwrap_err().is_out_of_bounds());
/// assert_eq!(string.as_str(), "ABCABBCD🤔");
/// assert!(string.try_insert_str(20, "C").unwrap_err().is_not_char_boundary());
/// assert!(string.try_insert_str(10, "D").unwrap_err().is_not_char_boundary());
/// # Ok(())
/// # }
/// ```
#[inline]
pub fn try_insert_str<S: AsRef<str>>(
&mut self,
index: usize,
string: S,
) -> Result<(), StringError> {
let string_ref = string.as_ref();
is_inside_boundary(self.len() + string_ref.len(), N)?;
is_char_boundary(self, index)?;
unsafe { self.insert_str_unchecked(index, string_ref) };
Ok(())
}
/// Returns the current length of the StaticString.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut s = StaticString::<20>::from("ABCD");
/// assert_eq!(s.len(), 4);
/// s.push('🤔');
/// assert_eq!(s.len(), 8);
/// ```
#[inline(always)]
pub const fn len(&self) -> usize {
self.vec.len()
}
/// Returns true if the StaticString has a current length of 0.
///
/// # Example usage:
/// ```
/// # use staticvec::{staticstring, StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = staticstring!("ABCD");
/// assert!(!s.is_empty());
/// s.clear();
/// assert!(s.is_empty());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub const fn is_empty(&self) -> bool {
self.vec.is_empty()
}
/// Returns true if the StaticString's length is equal to its capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::{staticstring, StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = staticstring!("ABCD");
/// assert!(s.is_full());
/// s.clear();
/// assert!(!s.is_full());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub const fn is_full(&self) -> bool {
self.vec.is_full()
}
/// Splits the StaticString in two if `at` is less than the its current length.
///
/// The original StaticString will contain elements `0..at`, and the new one will contain
/// elements `at..self.len()`.
///
/// Panics if `at` is greater than the length of the StaticString or if it does not
/// lie at a valid UTF-8 character boundary.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut ab = StaticString::<4>::from("ABCD");
/// let cd = ab.split_off(2);
/// assert_eq!(ab, "AB");
/// assert_eq!(cd, "CD");
/// ```
#[inline(always)]
pub fn split_off(&mut self, at: usize) -> Self {
assert!(
at <= self.len() && str_is_char_boundary(self.as_str(), at),
"Out of bounds or invalid character boundary!"
);
unsafe {
let res = Self::from_utf8_unchecked(self.as_str().get_unchecked(at..));
self.vec.set_len(at);
res
}
}
/// Removes all contents from the StaticString and sets its length back to zero.
///
/// # Example usage:
/// ```
/// # use staticvec::{StaticString, StringError};
/// # fn main() -> Result<(), StringError> {
/// let mut s = StaticString::<20>::try_from_str("ABCD")?;
/// assert!(!s.is_empty());
/// s.clear();
/// assert!(s.is_empty());
/// # Ok(())
/// # }
/// ```
#[inline(always)]
pub const fn clear(&mut self) {
unsafe { self.vec.set_len(0) };
}
/// Removes the specified range from the StaticString and replaces it with the provided input
/// (which does not need to have the same length as the range being removed), panicking if
/// either the high or low bounds of the range exceed `self.len()` or do not lie at valid UTF-8
/// character boundaries.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticString;
/// let mut s = StaticString::<20>::from("ABCD🤔");
/// s.replace_range(2..4, "EFGHI");
/// assert_eq!(s.as_str(), "ABEFGHI🤔");
/// ```
#[inline]
pub fn replace_range<S: AsRef<str>, R: RangeBounds<usize>>(&mut self, range: R, with: S) {
let replace_with = with.as_ref();
let old_length = self.len();
let start = match range.start_bound() {
Bound::Included(t) => *t,
Bound::Excluded(t) => t + 1,
Bound::Unbounded => 0,
};
let end = match range.end_bound() {
Bound::Included(t) => t + 1,
Bound::Excluded(t) => *t,
Bound::Unbounded => old_length,
};
let replace_length = replace_with.len();
assert!(
start <= end && end <= old_length,
"Invalid range or out of bounds!"
);
let replaced = end.saturating_sub(start);
assert!(
replaced + replace_length <= N
&& str_is_char_boundary(self, start)
&& str_is_char_boundary(self, end),
"Out of bounds or invalid character boundary!"
);
if replace_length == 0 {
unsafe {
self
.as_ptr()
.add(end)
.copy_to(self.as_mut_ptr().add(start), old_length.saturating_sub(end));
self.vec.set_len(old_length.saturating_sub(replaced));
}
} else {
if start + replace_length > end {
unsafe { shift_right_unchecked(self, end, start + replace_length) };
} else {
unsafe { shift_left_unchecked(self, end, start + replace_length) };
}
let ptr = replace_with.as_ptr();
let dest = unsafe { self.vec.as_mut_ptr().add(start) };
unsafe { ptr.copy_to_nonoverlapping(dest, replace_length) };
let grow: isize = replace_length as isize - replaced as isize;
unsafe { self.vec.set_len((old_length as isize + grow) as usize) };
}
}
}