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 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
use crate::any::type_name;
use crate::fmt;
use crate::intrinsics;
use crate::mem::{self, ManuallyDrop};
use crate::ptr;
use crate::slice;
/// 包装器类型,用于创建 `T` 的未初始化实例。
///
/// # 初始化不变量
///
/// 通常,编译器假定已根据变量类型的要求正确初始化了变量。例如,引用类型的变量必须对齐且非空。
/// 即使在不安全的代码中,这也必须始终保持不变。
/// 因此,将引用类型的变量初始化为零会导致瞬时 [未定义的行为][ub],无论该引用是否曾经用于访问内存:
///
/// ```rust,no_run
/// # #![allow(invalid_value)]
/// use std::mem::{self, MaybeUninit};
///
/// let x: &i32 = unsafe { mem::zeroed() }; // 未定义的行为! ⚠️
/// // 与 `MaybeUninit<&i32>` 等效的代码:
/// let x: &i32 = unsafe { MaybeUninit::zeroed().assume_init() }; // 未定义的行为! ⚠️
/// ```
///
/// 编译器利用这一点进行各种优化,例如取消运行时检查和优化 `enum` 布局。
///
/// 同样,完全未初始化的存储器可以包含任何内容,而 `bool` 必须始终为 `true` 或 `false`。因此,创建未初始化的 `bool` 是未定义的行为:
///
/// ```rust,no_run
/// # #![allow(invalid_value)]
/// use std::mem::{self, MaybeUninit};
///
/// let b: bool = unsafe { mem::uninitialized() }; // 未定义的行为! ⚠️
/// // 与 `MaybeUninit<bool>` 等效的代码:
/// let b: bool = unsafe { MaybeUninit::uninit().assume_init() }; // 未定义的行为! ⚠️
/// ```
///
/// 此外,未初始化的存储器的特殊之处在于它没有固定的值 ("fixed" 表示 "it won't change without being written to")。多次读取相同的未初始化字节会产生不同的结果。
/// 这使得在变量中具有未初始化的数据成为未定义的行为,即使该变量具有整数类型也可以保留任何固定位模式
///
/// ```rust,no_run
/// # #![allow(invalid_value)]
/// use std::mem::{self, MaybeUninit};
///
/// let x: i32 = unsafe { mem::uninitialized() }; // 未定义的行为! ⚠️
/// // 与 `MaybeUninit<i32>` 等效的代码:
/// let x: i32 = unsafe { MaybeUninit::uninit().assume_init() }; // 未定义的行为! ⚠️
/// ```
/// 最重要的是,请记住,大多数类型都有额外的不变量,而不仅仅是在类型级别被初始化。
/// 例如,将 `1` 初始化的 [`Vec<T>`] 视为已初始化 (在当前实现下; 这并不构成稳定的保证),因为编译器知道的唯一要求是数据指针必须为非空值。
/// 创建这样的 `Vec<T>` 不会立即导致未定义的行为,但是在大多数安全操作 (包括丢弃操作) 中都将导致未定义的行为。
///
/// [`Vec<T>`]: ../../std/vec/struct.Vec.html
///
/// # Examples
///
/// `MaybeUninit<T>` 用于启用不安全代码来处理未初始化的数据。
/// 这是向编译器发出的信号,指示此处的数据可能不被初始化:
///
/// ```rust
/// use std::mem::MaybeUninit;
///
/// // 创建一个显式未初始化的引用。
/// // 编译器知道 `MaybeUninit<T>` 内部的数据可能无效,因此不是 UB:
/// let mut x = MaybeUninit::<&i32>::uninit();
/// // 将其设置为有效值。
/// x.write(&0);
/// // 提取已初始化的数据 - 仅在正确初始化 `x` 之后 * 才允许这样做!
/////
/// let x = unsafe { x.assume_init() };
/// ```
///
/// 然后,编译器知道不会对此代码进行任何错误的假设或优化。
///
/// 您可以认为 `MaybeUninit<T>` 有点像 `Option<T>`,但是没有任何运行时跟踪且没有任何安全检查。
///
/// ## out-pointers
///
/// 您可以使用 `MaybeUninit<T>` 来实现 "out-pointers": 与其从函数中返回数据,还不如将其传递给某个 (uninitialized) 内存的指针以将结果放入其中。
/// 当对调用者来说,控制结果存储在内存中的分配方式很重要并且您希望避免不必要的移动时,这很有用。
///
/// ```
/// use std::mem::MaybeUninit;
///
/// unsafe fn make_vec(out: *mut Vec<i32>) {
/// // `write` 不丢弃旧内容,这一点很重要。
/// out.write(vec![1, 2, 3]);
/// }
///
/// let mut v = MaybeUninit::uninit();
/// unsafe { make_vec(v.as_mut_ptr()); }
/// // 现在我们知道 `v` 已初始化! 这也可以确保正确丢弃 vector。
/////
/// let v = unsafe { v.assume_init() };
/// assert_eq!(&v, &[1, 2, 3]);
/// ```
///
/// ## 逐元素初始化数组
///
/// `MaybeUninit<T>` 可用于逐个元素初始化大数组:
///
/// ```
/// use std::mem::{self, MaybeUninit};
///
/// let data = {
/// // 创建一个未初始化的 `MaybeUninit` 数组。
/// // `assume_init` 是安全的,因为我们声称这里已经初始化的类型是一堆 `MaybeUninit`,不需要初始化。
/////
/// let mut data: [MaybeUninit<Vec<u32>>; 1000] = unsafe {
/// MaybeUninit::uninit().assume_init()
/// };
///
/// // 丢弃 `MaybeUninit` 什么都不做
/////
/// for elem in &mut data[..] {
/// elem.write(vec![42]);
/// }
///
/// // 一切都已初始化。
/// // 将数组转换为初始化的类型。
/// unsafe { mem::transmute::<_, [Vec<u32>; 1000]>(data) }
/// };
///
/// assert_eq!(&data[0], &[42]);
/// ```
///
/// 您也可以使用部分初始化的数组,这些数组可以在不稳定的数据结构中找到。
///
/// ```
/// use std::mem::MaybeUninit;
///
/// // 创建一个未初始化的 `MaybeUninit` 数组。
/// // `assume_init` 是安全的,因为我们声称这里已经初始化的类型是一堆 `MaybeUninit`,不需要初始化。
/////
/// let mut data: [MaybeUninit<String>; 1000] = unsafe { MaybeUninit::uninit().assume_init() };
/// // 计算我们分配的元素数。
/// let mut data_len: usize = 0;
///
/// for elem in &mut data[0..500] {
/// elem.write(String::from("hello"));
/// data_len += 1;
/// }
///
/// // 对于数组中的每个项,如果我们分配了它,则将其丢弃。
/// for elem in &mut data[0..data_len] {
/// unsafe { elem.assume_init_drop(); }
/// }
/// ```
///
/// ## 逐字段初始化结构体
///
/// 您可以使用 `MaybeUninit<T>` 和 [`std::ptr::addr_of_mut`] 宏来逐字段初始化结构体:
///
/// ```rust
/// use std::mem::MaybeUninit;
/// use std::ptr::addr_of_mut;
///
/// #[derive(Debug, PartialEq)]
/// pub struct Foo {
/// name: String,
/// list: Vec<u8>,
/// }
///
/// let foo = {
/// let mut uninit: MaybeUninit<Foo> = MaybeUninit::uninit();
/// let ptr = uninit.as_mut_ptr();
///
/// // 初始化 `name` 字段 使用 `write` 而不是通过 `=` 赋值,而不是在旧的、未初始化的值上调用 `drop`。
/////
/////
/// unsafe { addr_of_mut!((*ptr).name).write("Bob".to_string()); }
///
/// // 初始化 `list` 字段如果此处存在 panic,则 `name` 字段中的 `String` 泄漏。
/////
/// unsafe { addr_of_mut!((*ptr).list).write(vec![0, 1, 2]); }
///
/// // 所有字段都已初始化,因此我们调用 `assume_init` 来获取已初始化的 Foo。
/// unsafe { uninit.assume_init() }
/// };
///
/// assert_eq!(
/// foo,
/// Foo {
/// name: "Bob".to_string(),
/// list: vec![0, 1, 2]
/// }
/// );
/// ```
/// [`std::ptr::addr_of_mut`]: crate::ptr::addr_of_mut
/// [ub]: ../../reference/behavior-considered-undefined.html
///
/// # Layout
///
/// `MaybeUninit<T>` 保证与 `T` 具有相同的大小、对齐方式和 ABI:
///
/// ```rust
/// use std::mem::{MaybeUninit, size_of, align_of};
/// assert_eq!(size_of::<MaybeUninit<u64>>(), size_of::<u64>());
/// assert_eq!(align_of::<MaybeUninit<u64>>(), align_of::<u64>());
/// ```
///
/// 但是请记住,*包含*`MaybeUninit<T>` 的类型不一定是相同的布局。Rust 通常不保证 `Foo<T>` 的字段具有与 `Foo<U>` 相同的顺序,即使 `T` 和 `U` 具有相同的大小和对齐方式。
///
/// 此外,由于任何位值对于 `MaybeUninit<T>` 都是有效的,因此编译器无法应用 non-zero/niche-filling 优化,从而可能导致更大的大小:
///
/// ```rust
/// # use std::mem::{MaybeUninit, size_of};
/// assert_eq!(size_of::<Option<bool>>(), 1);
/// assert_eq!(size_of::<Option<MaybeUninit<bool>>>(), 2);
/// ```
///
/// 如果 `T` 是 FFI 安全的,则 `MaybeUninit<T>` 也是如此。
///
/// 虽然 `MaybeUninit` 是 `#[repr(transparent)]` (表示它保证与 `T` 相同的大小,对齐方式和 ABI),但是这 *不会* 更改任何先前的警告。
/// `Option<T>` 和 `Option<MaybeUninit<T>>` 可能仍然具有不同的大小,并且包含 `T` 类型字段的类型的布局 (和大小) 可能与该字段为 `MaybeUninit<T>` 时不同。
/// `MaybeUninit` 是 union 类型,union 上的 `#[repr(transparent)]` 不稳定 (参见 [跟踪问题](https://github.com/rust-lang/rust/issues/60405)).
/// 随着时间的推移,对 union 的 `#[repr(transparent)]` 的确切保证可能会发生变化,并且 `MaybeUninit` 可能会或可能不会保留 `#[repr(transparent)]`。
/// 就是说,`MaybeUninit<T>` 将总是保证它具有与 `T` 有相同的大小、对齐方式和 ABI; 只是 `MaybeUninit` 实现保证的方式可能会演变。
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
#[stable(feature = "maybe_uninit", since = "1.36.0")]
// Lang 项,因此我们可以在其中包装其他类型。这对于生成器很有用。
#[lang = "maybe_uninit"]
#[derive(Copy)]
#[repr(transparent)]
pub union MaybeUninit<T> {
uninit: (),
value: ManuallyDrop<T>,
}
#[stable(feature = "maybe_uninit", since = "1.36.0")]
impl<T: Copy> Clone for MaybeUninit<T> {
#[inline(always)]
fn clone(&self) -> Self {
// 不调用 `T::clone()`,我们不知道我们是否已足够初始化。
*self
}
}
#[stable(feature = "maybe_uninit_debug", since = "1.41.0")]
impl<T> fmt::Debug for MaybeUninit<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.pad(type_name::<Self>())
}
}
impl<T> MaybeUninit<T> {
/// 创建一个使用给定值初始化的新 `MaybeUninit<T>`。
/// 在此函数的返回值上调用 [`assume_init`] 是安全的。
///
/// 注意,丢弃 `MaybeUninit<T>` 永远不会调用 T 的丢弃代码。
/// 确保 `T` 在初始化时被丢弃是您的责任。
///
/// # Example
///
/// ```
/// use std::mem::MaybeUninit;
///
/// let v: MaybeUninit<Vec<u8>> = MaybeUninit::new(vec![42]);
/// ```
///
/// [`assume_init`]: MaybeUninit::assume_init
#[stable(feature = "maybe_uninit", since = "1.36.0")]
#[rustc_const_stable(feature = "const_maybe_uninit", since = "1.36.0")]
#[must_use = "use `forget` to avoid running Drop code"]
#[inline(always)]
pub const fn new(val: T) -> MaybeUninit<T> {
MaybeUninit { value: ManuallyDrop::new(val) }
}
/// 以未初始化的状态创建一个新的 `MaybeUninit<T>`。
///
/// 注意,丢弃 `MaybeUninit<T>` 永远不会调用 T 的丢弃代码。
/// 确保 `T` 在初始化时被丢弃是您的责任。
///
/// 有关一些示例,请参见 [类型级文档][MaybeUninit]。
///
/// # Example
///
/// ```
/// use std::mem::MaybeUninit;
///
/// let v: MaybeUninit<String> = MaybeUninit::uninit();
/// ```
#[stable(feature = "maybe_uninit", since = "1.36.0")]
#[rustc_const_stable(feature = "const_maybe_uninit", since = "1.36.0")]
#[must_use]
#[inline(always)]
#[rustc_diagnostic_item = "maybe_uninit_uninit"]
pub const fn uninit() -> MaybeUninit<T> {
MaybeUninit { uninit: () }
}
/// 在未初始化状态下创建 `MaybeUninit<T>` 项的新数组。
///
/// Note: 在 future Rust 版本中,当 Rust 允许 [内联常量表达式](https://github.com/rust-lang/rust/issues/76001) 时,此方法可能变得不必要。
///
/// 下面的示例可以使用 `let mut buf = [const { MaybeUninit::<u8>::uninit() }; 32];`。
///
/// # Examples
///
/// ```no_run
/// #![feature(maybe_uninit_uninit_array, maybe_uninit_slice)]
///
/// use std::mem::MaybeUninit;
///
/// extern "C" {
/// fn read_into_buffer(ptr: *mut u8, max_len: usize) -> usize;
/// }
///
/// /// 返回实际读取的 (可能较小的) 数据切片
/// fn read(buf: &mut [MaybeUninit<u8>]) -> &[u8] {
/// unsafe {
/// let len = read_into_buffer(buf.as_mut_ptr() as *mut u8, buf.len());
/// MaybeUninit::slice_assume_init_ref(&buf[..len])
/// }
/// }
///
/// let mut buf: [MaybeUninit<u8>; 32] = MaybeUninit::uninit_array();
/// let data = read(&mut buf);
/// ```
///
#[unstable(feature = "maybe_uninit_uninit_array", issue = "96097")]
#[rustc_const_unstable(feature = "const_maybe_uninit_uninit_array", issue = "96097")]
#[must_use]
#[inline(always)]
pub const fn uninit_array<const N: usize>() -> [Self; N] {
// SAFETY: 未初始化的 `[MaybeUninit<_>; LEN]` 有效。
unsafe { MaybeUninit::<[MaybeUninit<T>; N]>::uninit().assume_init() }
}
/// 在未初始化状态下创建新的 `MaybeUninit<T>`,并用 `0` 字节填充内存。取决于 `T` 是否已经进行了正确的初始化。
///
/// 例如,初始化 `MaybeUninit<usize>::zeroed()`,但不初始化 `MaybeUninit<&'static i32>::zeroed()`,因为引用不能为空。
///
/// 注意,丢弃 `MaybeUninit<T>` 永远不会调用 T 的丢弃代码。
/// 确保 `T` 在初始化时被丢弃是您的责任。
///
/// # Example
///
/// 此函数的正确用法:用零初始化结构体,其中结构体的所有字段都可以将位模式 0 保留为有效值。
///
/// ```rust
/// use std::mem::MaybeUninit;
///
/// let x = MaybeUninit::<(u8, bool)>::zeroed();
/// let x = unsafe { x.assume_init() };
/// assert_eq!(x, (0, false));
/// ```
///
/// 该函数的 *错误* 用法:当 `0` 不是该类型的有效位模式时,调用 `x.zeroed().assume_init()`:
///
/// ```rust,no_run
/// use std::mem::MaybeUninit;
///
/// enum NotZero { One = 1, Two = 2 }
///
/// let x = MaybeUninit::<(u8, NotZero)>::zeroed();
/// let x = unsafe { x.assume_init() };
/// // 在一个对中,我们创建一个没有有效判别式的 `NotZero`。
/// // 这是未定义的行为。⚠️
/// ```
///
///
///
///
#[stable(feature = "maybe_uninit", since = "1.36.0")]
#[rustc_const_unstable(feature = "const_maybe_uninit_zeroed", issue = "91850")]
#[must_use]
#[inline]
#[rustc_diagnostic_item = "maybe_uninit_zeroed"]
pub const fn zeroed() -> MaybeUninit<T> {
let mut u = MaybeUninit::<T>::uninit();
// SAFETY: `u.as_mut_ptr()` 指向分配的内存。
unsafe {
u.as_mut_ptr().write_bytes(0u8, 1);
}
u
}
/// 设置 `MaybeUninit<T>` 的值。
///
/// 这将覆盖任何先前的值而不将其丢弃,因此请注意不要重复使用此两次,除非您要跳过运行析构函数。
/// 为了您的方便,这也将 `self` 的内容 (现在已安全初始化) 返回变量引用。
///
/// 由于内容存储在 `MaybeUninit` 中,如果 MaybeUninit 离开作用域而没有调用到 [`assume_init`]、[`assume_init_drop`] 或类似对象,则不会为内部数据运行析构函数。
/// 接收该函数返回的可变引用的代码需要记住这一点。
/// Rust 的安全模型认为泄漏是安全的,但它们通常仍然是不可取的。
/// 话虽这么说,但借用引用与其他任何一个借用引用一样,因此为其赋予新的值将摒弃旧的内容。
///
/// [`assume_init`]: Self::assume_init
/// [`assume_init_drop`]: Self::assume_init_drop
///
/// # Examples
///
/// 正确使用此方法:
///
/// ```rust
/// use std::mem::MaybeUninit;
///
/// let mut x = MaybeUninit::<Vec<u8>>::uninit();
///
/// {
/// let hello = x.write((&b"Hello, world!").to_vec());
/// // 设置 hello 不会预先分配,但不会泄漏它们
/// *hello = (&b"Hello").to_vec();
/// hello[0] = 'h' as u8;
/// }
/// // x 现在初始化:
/// let s = unsafe { x.assume_init() };
/// assert_eq!(b"hello", s.as_slice());
/// ```
///
/// 该方法的这种用法会导致泄漏:
///
/// ```rust
/// use std::mem::MaybeUninit;
///
/// let mut x = MaybeUninit::<String>::uninit();
///
/// x.write("Hello".to_string());
/// // 这会泄漏包含的字符串:
/// x.write("hello".to_string());
/// // x 现在初始化:
/// let s = unsafe { x.assume_init() };
/// ```
///
/// 这种方法可以用来避免在某些情况下不安全。下面的例子展示了一个固定大小的 arena 实现的一部分,它提供了固定的引用。
/// 有了 `write`,我们就可以避免通过裸指针路径来写:
///
/// ```rust
/// use core::pin::Pin;
/// use core::mem::MaybeUninit;
///
/// struct PinArena<T> {
/// memory: Box<[MaybeUninit<T>]>,
/// len: usize,
/// }
///
/// impl <T> PinArena<T> {
/// pub fn capacity(&self) -> usize {
/// self.memory.len()
/// }
/// pub fn push(&mut self, val: T) -> Pin<&mut T> {
/// if self.len >= self.capacity() {
/// panic!("Attempted to push to a full pin arena!");
/// }
/// let ref_ = self.memory[self.len].write(val);
/// self.len += 1;
/// unsafe { Pin::new_unchecked(ref_) }
/// }
/// }
/// ```
///
///
///
///
///
///
///
///
#[stable(feature = "maybe_uninit_write", since = "1.55.0")]
#[rustc_const_unstable(feature = "const_maybe_uninit_write", issue = "63567")]
#[inline(always)]
pub const fn write(&mut self, val: T) -> &mut T {
*self = MaybeUninit::new(val);
// SAFETY: 我们刚刚初始化了这个值。
unsafe { self.assume_init_mut() }
}
/// 获取指向所包含值的指针。
/// 除非初始化 `MaybeUninit<T>`,否则从该指针读取或将其转换为 quot 是未定义的行为。
/// 写入该指针 (non-transitively) 指向的内存是未定义的行为 (`UnsafeCell<T>` 内部除外)。
///
/// # Examples
///
/// 正确使用此方法:
///
/// ```rust
/// use std::mem::MaybeUninit;
///
/// let mut x = MaybeUninit::<Vec<u32>>::uninit();
/// x.write(vec![0, 1, 2]);
/// // 在 `MaybeUninit<T>` 中创建引用。可以,因为我们已将其初始化。
/// let x_vec = unsafe { &*x.as_ptr() };
/// assert_eq!(x_vec.len(), 3);
/// ```
///
/// 这个方法的错误用法:
///
/// ```rust,no_run
/// use std::mem::MaybeUninit;
///
/// let x = MaybeUninit::<Vec<u32>>::uninit();
/// let x_vec = unsafe { &*x.as_ptr() };
/// // 我们创建了对未初始化的 vector 的引用! 这是未定义的行为。⚠️
/// ```
///
/// (请注意,围绕未初始化数据引用的规则尚未最终确定,但是除非被确定,否则建议避免使用它们。)
///
///
#[stable(feature = "maybe_uninit", since = "1.36.0")]
#[rustc_const_stable(feature = "const_maybe_uninit_as_ptr", since = "1.59.0")]
#[inline(always)]
pub const fn as_ptr(&self) -> *const T {
// `MaybeUninit` 和 `ManuallyDrop` 都是 `repr(transparent)`,所以我们可以转换指针。
self as *const _ as *const T
}
/// 获取指向包含值的可变指针。
/// 除非初始化 `MaybeUninit<T>`,否则从该指针读取或将其转换为 quot 是未定义的行为。
///
/// # Examples
///
/// 正确使用此方法:
///
/// ```rust
/// use std::mem::MaybeUninit;
///
/// let mut x = MaybeUninit::<Vec<u32>>::uninit();
/// x.write(vec![0, 1, 2]);
/// // 在 `MaybeUninit<Vec<u32>>` 中创建引用。
/// // 可以,因为我们已将其初始化。
/// let x_vec = unsafe { &mut *x.as_mut_ptr() };
/// x_vec.push(3);
/// assert_eq!(x_vec.len(), 4);
/// ```
///
/// 这个方法的错误用法:
///
/// ```rust,no_run
/// use std::mem::MaybeUninit;
///
/// let mut x = MaybeUninit::<Vec<u32>>::uninit();
/// let x_vec = unsafe { &mut *x.as_mut_ptr() };
/// // 我们创建了对未初始化的 vector 的引用! 这是未定义的行为。⚠️
/// ```
///
/// (请注意,围绕未初始化数据引用的规则尚未最终确定,但是除非被确定,否则建议避免使用它们。)
///
#[stable(feature = "maybe_uninit", since = "1.36.0")]
#[rustc_const_unstable(feature = "const_maybe_uninit_as_mut_ptr", issue = "75251")]
#[inline(always)]
pub const fn as_mut_ptr(&mut self) -> *mut T {
// `MaybeUninit` 和 `ManuallyDrop` 都是 `repr(transparent)`,所以我们可以转换指针。
self as *mut _ as *mut T
}
/// 从 `MaybeUninit<T>` 容器中提取值。这是确保数据将被丢弃的好方法,因为生成的 `T` 受到通常的丢弃处理。
///
/// # Safety
///
/// 取决于调用者,以确保 `MaybeUninit<T>` 确实处于初始化状态。在内容尚未完全初始化时调用此方法会立即导致未定义的行为。
/// [类型级文档][inv] 中包含了有关此初始化不变量的更多信息。
///
/// [inv]: #initialization-invariant
///
/// 最重要的是,请记住,大多数类型都有额外的不变量,而不仅仅是在类型级别被初始化。
/// 例如,将 `1` 初始化的 [`Vec<T>`] 视为已初始化 (在当前实现下; 这并不构成稳定的保证),因为编译器知道的唯一要求是数据指针必须为非空值。
///
/// 创建这样的 `Vec<T>` 不会立即导致未定义的行为,但是在大多数安全操作 (包括丢弃操作) 中都将导致未定义的行为。
///
/// [`Vec<T>`]: ../../std/vec/struct.Vec.html
///
/// # Examples
///
/// 正确使用此方法:
///
/// ```rust
/// use std::mem::MaybeUninit;
///
/// let mut x = MaybeUninit::<bool>::uninit();
/// x.write(true);
/// let x_init = unsafe { x.assume_init() };
/// assert_eq!(x_init, true);
/// ```
///
/// 这个方法的错误用法:
///
/// ```rust,no_run
/// use std::mem::MaybeUninit;
///
/// let x = MaybeUninit::<Vec<u32>>::uninit();
/// let x_init = unsafe { x.assume_init() };
/// // `x` 尚未初始化,因此最后一行导致未定义的行为。⚠️
/// ```
///
///
///
///
///
///
///
#[stable(feature = "maybe_uninit", since = "1.36.0")]
#[rustc_const_stable(feature = "const_maybe_uninit_assume_init_by_value", since = "1.59.0")]
#[inline(always)]
#[rustc_diagnostic_item = "assume_init"]
#[track_caller]
pub const unsafe fn assume_init(self) -> T {
// SAFETY: 调用者必须保证 `self` 已初始化。
// 这也意味着 `self` 必须是 `value` 变体。
unsafe {
intrinsics::assert_inhabited::<T>();
ManuallyDrop::into_inner(self.value)
}
}
/// 从 `MaybeUninit<T>` 容器中读取值。结果 `T` 受通常的 drop 处理影响。
///
/// 只要有可能,最好改用 [`assume_init`],这样可以防止重复 `MaybeUninit<T>` 的内容。
///
/// # Safety
///
/// 取决于调用者,以确保 `MaybeUninit<T>` 确实处于初始化状态。在内容尚未完全初始化时调用此方法会导致未定义的行为。
/// [类型级文档][inv] 中包含了有关此初始化不变量的更多信息。
///
/// 此外,类似于 [`ptr::read`] 函数,该函数创建内容的按位副本,无论所包含的类型是否实现 [`Copy`] trait。
/// 当使用数据的多个副本时 (通过多次调用 `assume_init_read`,或先调用 `assume_init_read` 再调用 [`assume_init`]),您有责任确保数据确实可能重复。
///
///
/// [inv]: #initialization-invariant
/// [`assume_init`]: MaybeUninit::assume_init
///
/// # Examples
///
/// 正确使用此方法:
///
/// ```rust
/// use std::mem::MaybeUninit;
///
/// let mut x = MaybeUninit::<u32>::uninit();
/// x.write(13);
/// let x1 = unsafe { x.assume_init_read() };
/// // `u32` 是 `Copy`,因此我们可能会读取多次。
/// let x2 = unsafe { x.assume_init_read() };
/// assert_eq!(x1, x2);
///
/// let mut x = MaybeUninit::<Option<Vec<u32>>>::uninit();
/// x.write(None);
/// let x1 = unsafe { x.assume_init_read() };
/// // 复制 `None` 值是可以的,因此我们可能会多次读取。
/// let x2 = unsafe { x.assume_init_read() };
/// assert_eq!(x1, x2);
/// ```
///
/// 这个方法的错误用法:
///
/// ```rust,no_run
/// use std::mem::MaybeUninit;
///
/// let mut x = MaybeUninit::<Option<Vec<u32>>>::uninit();
/// x.write(Some(vec![0, 1, 2]));
/// let x1 = unsafe { x.assume_init_read() };
/// let x2 = unsafe { x.assume_init_read() };
/// // 现在,我们创建了同一 vector 的两个副本,当它们都被丢弃时,将导致双重释放!
/////
/// ```
///
///
///
///
///
///
///
#[stable(feature = "maybe_uninit_extra", since = "1.60.0")]
#[rustc_const_unstable(feature = "const_maybe_uninit_assume_init_read", issue = "63567")]
#[inline(always)]
#[track_caller]
pub const unsafe fn assume_init_read(&self) -> T {
// SAFETY: 调用者必须保证 `self` 已初始化。
// 从 `self.as_ptr()` 读取数据是安全的,因为应该初始化 `self`。
unsafe {
intrinsics::assert_inhabited::<T>();
self.as_ptr().read()
}
}
/// 将包含的值放置到位。
///
/// 如果您拥有 `MaybeUninit`,您也可以使用 [`assume_init`] 作为替代。
///
/// # Safety
///
/// 取决于调用者,以确保 `MaybeUninit<T>` 确实处于初始化状态。
/// 在内容尚未完全初始化时调用此方法会导致未定义的行为。
///
/// 最重要的是,必须满足类型 `T` 的所有附加不变量,因为 `T` (或其变体) 的 `Drop` 实现可能依赖于此。
///
/// 例如,将 [`Vec<T>`] 设置为无效但非空的地址使其初始化 (在当前实现下;
/// 这并不构成稳定的保证),因为编译器知道的唯一要求是数据指针必须非空。
/// 但是,丢弃这样的 `Vec<T>` 会导致不确定的行为。
///
/// [`assume_init`]: MaybeUninit::assume_init
/// [`Vec<T>`]: ../../std/vec/struct.Vec.html
///
///
///
///
///
#[stable(feature = "maybe_uninit_extra", since = "1.60.0")]
pub unsafe fn assume_init_drop(&mut self) {
// SAFETY: 调用者必须保证 `self` 已初始化并且满足 `T` 的所有不变量。
//
// 在这种情况下,将值放到适当的位置是安全的。
unsafe { ptr::drop_in_place(self.as_mut_ptr()) }
}
/// 获取对包含的值的共享引用。
///
/// 当我们要访问已初始化但没有 `MaybeUninit` 所有权 (防止使用 `.assume_init()`) 的 `MaybeUninit` 时,这很有用。
///
/// # Safety
///
/// 在内容尚未完全初始化时调用此方法会导致未定义的行为:取决于调用者,以确保 `MaybeUninit<T>` 确实处于初始化状态。
///
///
/// # Examples
///
/// ### 正确使用此方法:
///
/// ```rust
/// use std::mem::MaybeUninit;
///
/// let mut x = MaybeUninit::<Vec<u32>>::uninit();
/// // 初始化 `x`:
/// x.write(vec![1, 2, 3]);
/// // 现在已知我们的 `MaybeUninit<_>` 已初始化,可以创建对其的共享引用:
/////
/// let x: &Vec<u32> = unsafe {
/// // SAFETY: `x` 已初始化。
/// x.assume_init_ref()
/// };
/// assert_eq!(x, &vec![1, 2, 3]);
/// ```
///
/// ### 这个方法的错误用法:
///
/// ```rust,no_run
/// use std::mem::MaybeUninit;
///
/// let x = MaybeUninit::<Vec<u32>>::uninit();
/// let x_vec: &Vec<u32> = unsafe { x.assume_init_ref() };
/// // 我们创建了对未初始化的 vector 的引用! 这是未定义的行为。⚠️
/// ```
///
/// ```rust,no_run
/// use std::{cell::Cell, mem::MaybeUninit};
///
/// let b = MaybeUninit::<Cell<bool>>::uninit();
/// // 使用 `Cell::set` 初始化 `MaybeUninit`:
/// unsafe {
/// b.assume_init_ref().set(true);
/// // ^^^^^^^^^^^^^^^
/// // 引用未初始化的 `Cell<bool>`: UB!
/// }
/// ```
///
///
///
#[stable(feature = "maybe_uninit_ref", since = "1.55.0")]
#[rustc_const_stable(feature = "const_maybe_uninit_assume_init_ref", since = "1.59.0")]
#[inline(always)]
pub const unsafe fn assume_init_ref(&self) -> &T {
// SAFETY: 调用者必须保证 `self` 已初始化。
// 这也意味着 `self` 必须是 `value` 变体。
unsafe {
intrinsics::assert_inhabited::<T>();
&*self.as_ptr()
}
}
/// 获取所包含值的可变 (unique) 引用。
///
/// 当我们要访问已初始化但没有 `MaybeUninit` 所有权 (防止使用 `.assume_init()`) 的 `MaybeUninit` 时,这很有用。
///
/// # Safety
///
/// 在内容尚未完全初始化时调用此方法会导致未定义的行为:取决于调用者,以确保 `MaybeUninit<T>` 确实处于初始化状态。
/// 例如,`.assume_init_mut()` 不能用于初始化 `MaybeUninit`。
///
/// # Examples
///
/// ### 正确使用此方法:
///
/// ```rust
/// # #![allow(unexpected_cfgs)]
/// use std::mem::MaybeUninit;
///
/// # unsafe extern "C" fn initialize_buffer(buf: *mut [u8; 1024]) { *buf = [0; 1024] }
/// # #[cfg(FALSE)]
/// extern "C" {
/// /// 初始化所有输入缓冲区的字节。
/// fn initialize_buffer(buf: *mut [u8; 1024]);
/// }
///
/// let mut buf = MaybeUninit::<[u8; 1024]>::uninit();
///
/// // 初始化 `buf`:
/// unsafe { initialize_buffer(buf.as_mut_ptr()); }
/// // 现在我们知道 `buf` 已被初始化,因此我们可以对其进行 `.assume_init()`。
/// // 但是,使用 `.assume_init()` 可能会触发 1024 字节的 `memcpy`。
/// // 为了断言我们的缓冲区已经初始化而不复制它,我们将 `&mut MaybeUninit<[u8; 1024]>` 升级为 `&mut [u8; 1024]`:
/////
/// let buf: &mut [u8; 1024] = unsafe {
/// // SAFETY: `buf` 已初始化。
/// buf.assume_init_mut()
/// };
///
/// // 现在我们可以将 `buf` 用作普通切片:
/// buf.sort_unstable();
/// assert!(
/// buf.windows(2).all(|pair| pair[0] <= pair[1]),
/// "buffer is sorted",
/// );
/// ```
///
/// ### 这个方法的错误用法:
///
/// 您不能使用 `.assume_init_mut()` 初始化值:
///
/// ```rust,no_run
/// use std::mem::MaybeUninit;
///
/// let mut b = MaybeUninit::<bool>::uninit();
/// unsafe {
/// *b.assume_init_mut() = true;
/// // 我们已经创建了 (mutable) 引用未初始化的 `bool`!
/// // 这是未定义的行为。⚠️
/// }
/// ```
///
/// 例如,您不能 [`Read`] 进入未初始化的缓冲区:
///
/// [`Read`]: ../../std/io/trait.Read.html
///
/// ```rust,no_run
/// use std::{io, mem::MaybeUninit};
///
/// fn read_chunk (reader: &'_ mut dyn io::Read) -> io::Result<[u8; 64]>
/// {
/// let mut buffer = MaybeUninit::<[u8; 64]>::uninit();
/// reader.read_exact(unsafe { buffer.assume_init_mut() })?;
/// // ^^^^^^^^^^^^^^^^^^^^^^^^
/// // (mutable) 引用到未初始化的内存!
/// // 这是未定义的行为。
/// Ok(unsafe { buffer.assume_init() })
/// }
/// ```
///
/// 也不能使用直接字段访问来进行逐字段逐步初始化:
///
/// ```rust,no_run
/// use std::{mem::MaybeUninit, ptr};
///
/// struct Foo {
/// a: u32,
/// b: u8,
/// }
///
/// let foo: Foo = unsafe {
/// let mut foo = MaybeUninit::<Foo>::uninit();
/// ptr::write(&mut foo.assume_init_mut().a as *mut u32, 1337);
/// // ^^^^^^^^^^^^^^^^^^^^^
/// // (mutable) 引用到未初始化的内存!
/// // 这是未定义的行为。
/// ptr::write(&mut foo.assume_init_mut().b as *mut u8, 42);
/// // ^^^^^^^^^^^^^^^^^^^^^
/// // (mutable) 引用到未初始化的内存!
/// // 这是未定义的行为。
/// foo.assume_init()
/// };
/// ```
///
///
///
///
#[stable(feature = "maybe_uninit_ref", since = "1.55.0")]
#[rustc_const_unstable(feature = "const_maybe_uninit_assume_init", issue = "none")]
#[inline(always)]
pub const unsafe fn assume_init_mut(&mut self) -> &mut T {
// SAFETY: 调用者必须保证 `self` 已初始化。
// 这也意味着 `self` 必须是 `value` 变体。
unsafe {
intrinsics::assert_inhabited::<T>();
&mut *self.as_mut_ptr()
}
}
/// 从 `MaybeUninit` 容器数组中提取值。
///
/// # Safety
///
/// 调用者有责任保证数组的所有元素都处于初始化状态。
///
///
/// # Examples
///
/// ```
/// #![feature(maybe_uninit_uninit_array)]
/// #![feature(maybe_uninit_array_assume_init)]
/// use std::mem::MaybeUninit;
///
/// let mut array: [MaybeUninit<i32>; 3] = MaybeUninit::uninit_array();
/// array[0].write(0);
/// array[1].write(1);
/// array[2].write(2);
///
/// // SAFETY: 现在安全了,因为我们初始化了所有元素
/// let array = unsafe {
/// MaybeUninit::array_assume_init(array)
/// };
///
/// assert_eq!(array, [0, 1, 2]);
/// ```
#[unstable(feature = "maybe_uninit_array_assume_init", issue = "96097")]
#[rustc_const_unstable(feature = "const_maybe_uninit_array_assume_init", issue = "96097")]
#[inline(always)]
#[track_caller]
pub const unsafe fn array_assume_init<const N: usize>(array: [Self; N]) -> [T; N] {
// SAFETY:
// * 调用者保证数组的所有元素都已初始化
// * `MaybeUninit<T>` 和 T 保证有相同的布局
// * `MaybeUninit` 不丢弃,因此没有双重释放,因此转换是安全的
//
unsafe {
intrinsics::assert_inhabited::<[T; N]>();
intrinsics::transmute_unchecked(array)
}
}
/// 假设所有元素都已初始化,请对其进行切片。
///
/// # Safety
///
/// 取决于调用者,以确保 `MaybeUninit<T>` 元素确实处于初始化状态。
///
/// 在内容尚未完全初始化时调用此方法会导致未定义的行为。
///
/// 有关更多详细信息和示例,请参见 [`assume_init_ref`]。
///
/// [`assume_init_ref`]: MaybeUninit::assume_init_ref
#[unstable(feature = "maybe_uninit_slice", issue = "63569")]
#[rustc_const_unstable(feature = "maybe_uninit_slice", issue = "63569")]
#[inline(always)]
pub const unsafe fn slice_assume_init_ref(slice: &[Self]) -> &[T] {
// SAFETY: 将 `slice` 转换为 `*const [T]` 是安全的,因为调用者保证 `slice` 已初始化,并且 `MaybeUninit` 保证与 `T` 具有相同的布局。
//
// 所获得的指针是有效的,因为它引用 `slice` 拥有的内存,该内存是一个引用,因此可以保证对读取有效。
//
unsafe { &*(slice as *const [Self] as *const [T]) }
}
/// 假设所有元素都已初始化,请为其获取可变切片。
///
/// # Safety
///
/// 取决于调用者,以确保 `MaybeUninit<T>` 元素确实处于初始化状态。
///
/// 在内容尚未完全初始化时调用此方法会导致未定义的行为。
///
/// 有关更多详细信息和示例,请参见 [`assume_init_mut`]。
///
/// [`assume_init_mut`]: MaybeUninit::assume_init_mut
#[unstable(feature = "maybe_uninit_slice", issue = "63569")]
#[rustc_const_unstable(feature = "const_maybe_uninit_assume_init", issue = "none")]
#[inline(always)]
pub const unsafe fn slice_assume_init_mut(slice: &mut [Self]) -> &mut [T] {
// SAFETY: 类似于 `slice_get_ref` 的安全说明,但我们有一个可变引用,也保证对写操作有效。
//
unsafe { &mut *(slice as *mut [Self] as *mut [T]) }
}
/// 获取指向数组第一个元素的指针。
#[unstable(feature = "maybe_uninit_slice", issue = "63569")]
#[rustc_const_unstable(feature = "maybe_uninit_slice", issue = "63569")]
#[inline(always)]
pub const fn slice_as_ptr(this: &[MaybeUninit<T>]) -> *const T {
this.as_ptr() as *const T
}
/// 获取指向数组第一个元素的可变指针。
#[unstable(feature = "maybe_uninit_slice", issue = "63569")]
#[rustc_const_unstable(feature = "maybe_uninit_slice", issue = "63569")]
#[inline(always)]
pub const fn slice_as_mut_ptr(this: &mut [MaybeUninit<T>]) -> *mut T {
this.as_mut_ptr() as *mut T
}
/// 从 `src` 复制元素,将 `this` 现在初始化的内容返回给 `this` 的资源引用。
///
/// 如果 `T` 未实现 `Copy`,请使用 [`write_slice_cloned`]
///
/// 这类似于 [`slice::copy_from_slice`]。
///
/// # Panics
///
/// 如果两个切片的长度不同,则此函数将为 panic。
///
/// # Examples
///
/// ```
/// #![feature(maybe_uninit_write_slice)]
/// use std::mem::MaybeUninit;
///
/// let mut dst = [MaybeUninit::uninit(); 32];
/// let src = [0; 32];
///
/// let init = MaybeUninit::write_slice(&mut dst, &src);
///
/// assert_eq!(init, src);
/// ```
///
/// ```
/// #![feature(maybe_uninit_write_slice)]
/// use std::mem::MaybeUninit;
///
/// let mut vec = Vec::with_capacity(32);
/// let src = [0; 16];
///
/// MaybeUninit::write_slice(&mut vec.spare_capacity_mut()[..src.len()], &src);
///
/// // SAFETY: 我们刚刚将 len 的所有元素复制到了备用容量中,vec 的第一个 src.len() 元素现在有效。
/////
/// unsafe {
/// vec.set_len(src.len());
/// }
///
/// assert_eq!(vec, src);
/// ```
///
/// [`write_slice_cloned`]: MaybeUninit::write_slice_cloned
#[unstable(feature = "maybe_uninit_write_slice", issue = "79995")]
pub fn write_slice<'a>(this: &'a mut [MaybeUninit<T>], src: &[T]) -> &'a mut [T]
where
T: Copy,
{
// SAFETY: &[T] and &[MaybeUninit<T>] 具有相同的布局
let uninit_src: &[MaybeUninit<T>] = unsafe { super::transmute(src) };
this.copy_from_slice(uninit_src);
// SAFETY: 有效元素刚刚被复制到 `this` 中,因此它被初始化
unsafe { MaybeUninit::slice_assume_init_mut(this) }
}
/// 将元素从 `src` 克隆到 `this`,返回对 `this` 现在初始化内容的可变引用。
/// 任何已经初始化的元素都不会被丢弃。
///
/// 如果 `T` 实现 `Copy`,请使用 [`write_slice`]
///
/// 这类似于 [`slice::clone_from_slice`],但不会丢弃现有元素。
///
/// # Panics
///
/// 如果两个切片的长度不同,或者 `Clone` panics 的实现,则此函数将为 panic。
///
/// 如果存在 panic,将丢弃已经克隆的元素。
///
/// # Examples
///
/// ```
/// #![feature(maybe_uninit_write_slice)]
/// use std::mem::MaybeUninit;
///
/// let mut dst = [MaybeUninit::uninit(), MaybeUninit::uninit(), MaybeUninit::uninit(), MaybeUninit::uninit(), MaybeUninit::uninit()];
/// let src = ["wibbly".to_string(), "wobbly".to_string(), "timey".to_string(), "wimey".to_string(), "stuff".to_string()];
///
/// let init = MaybeUninit::write_slice_cloned(&mut dst, &src);
///
/// assert_eq!(init, src);
/// ```
///
/// ```
/// #![feature(maybe_uninit_write_slice)]
/// use std::mem::MaybeUninit;
///
/// let mut vec = Vec::with_capacity(32);
/// let src = ["rust", "is", "a", "pretty", "cool", "language"];
///
/// MaybeUninit::write_slice_cloned(&mut vec.spare_capacity_mut()[..src.len()], &src);
///
/// // SAFETY: 我们刚刚将 len 的所有元素克隆到了备用容量中,vec 的第一个 src.len() 元素现在有效。
/////
/// unsafe {
/// vec.set_len(src.len());
/// }
///
/// assert_eq!(vec, src);
/// ```
///
/// [`write_slice`]: MaybeUninit::write_slice
#[unstable(feature = "maybe_uninit_write_slice", issue = "79995")]
pub fn write_slice_cloned<'a>(this: &'a mut [MaybeUninit<T>], src: &[T]) -> &'a mut [T]
where
T: Clone,
{
// 与 copy_from_slice 不同,这不会在切片上调用 clone_from_slice,这是因为 `MaybeUninit<T: Clone>` 没有实现 Clone。
//
struct Guard<'a, T> {
slice: &'a mut [MaybeUninit<T>],
initialized: usize,
}
impl<'a, T> Drop for Guard<'a, T> {
fn drop(&mut self) {
let initialized_part = &mut self.slice[..self.initialized];
// SAFETY: 此原始切片将仅包含初始化的对象,这就是为什么允许将其丢弃。
//
unsafe {
crate::ptr::drop_in_place(MaybeUninit::slice_assume_init_mut(initialized_part));
}
}
}
assert_eq!(this.len(), src.len(), "destination and source slices have different lengths");
// NOTE: 我们需要显式地将它们切成相同的长度,以消除边界检查,优化器将为简单情况生成 memcpy (例如 T= u8)。
//
//
let len = this.len();
let src = &src[..len];
// 需要保护 b/c 在克隆过程中可能会发生 panic
let mut guard = Guard { slice: this, initialized: 0 };
for i in 0..len {
guard.slice[i].write(src[i].clone());
guard.initialized += 1;
}
super::forget(guard);
// SAFETY: 有效元素刚刚被写入 `this`,因此它被初始化
unsafe { MaybeUninit::slice_assume_init_mut(this) }
}
/// 将此 `MaybeUninit` 的内容作为可能未初始化的字节切片返回。
///
/// 请注意,即使 `MaybeUninit` 的内容已初始化,该值仍可能包含未初始化的填充字节。
///
///
/// # Examples
///
/// ```
/// #![feature(maybe_uninit_as_bytes, maybe_uninit_slice)]
/// use std::mem::MaybeUninit;
///
/// let val = 0x12345678_i32;
/// let uninit = MaybeUninit::new(val);
/// let uninit_bytes = uninit.as_bytes();
/// let bytes = unsafe { MaybeUninit::slice_assume_init_ref(uninit_bytes) };
/// assert_eq!(bytes, val.to_ne_bytes());
/// ```
#[unstable(feature = "maybe_uninit_as_bytes", issue = "93092")]
pub fn as_bytes(&self) -> &[MaybeUninit<u8>] {
// SAFETY: MaybeUninit<u8> 始终有效,即使对于填充字节也是如此
unsafe {
slice::from_raw_parts(self.as_ptr() as *const MaybeUninit<u8>, mem::size_of::<T>())
}
}
/// 返回此 `MaybeUninit` 的内容作为可能未初始化字节的可变切片返回。
///
/// 请注意,即使 `MaybeUninit` 的内容已初始化,该值仍可能包含未初始化的填充字节。
///
///
/// # Examples
///
/// ```
/// #![feature(maybe_uninit_as_bytes)]
/// use std::mem::MaybeUninit;
///
/// let val = 0x12345678_i32;
/// let mut uninit = MaybeUninit::new(val);
/// let uninit_bytes = uninit.as_bytes_mut();
/// if cfg!(target_endian = "little") {
/// uninit_bytes[0].write(0xcd);
/// } else {
/// uninit_bytes[3].write(0xcd);
/// }
/// let val2 = unsafe { uninit.assume_init() };
/// assert_eq!(val2, 0x123456cd);
/// ```
///
#[unstable(feature = "maybe_uninit_as_bytes", issue = "93092")]
pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>] {
// SAFETY: MaybeUninit<u8> 始终有效,即使对于填充字节也是如此
unsafe {
slice::from_raw_parts_mut(
self.as_mut_ptr() as *mut MaybeUninit<u8>,
mem::size_of::<T>(),
)
}
}
/// 将此 `MaybeUninit` 切片的内容作为可能未初始化的字节切片返回。
///
/// 请注意,即使 `MaybeUninit` 的内容已初始化,该值仍可能包含未初始化的填充字节。
///
///
/// # Examples
///
/// ```
/// #![feature(maybe_uninit_as_bytes, maybe_uninit_write_slice, maybe_uninit_slice)]
/// use std::mem::MaybeUninit;
///
/// let uninit = [MaybeUninit::new(0x1234u16), MaybeUninit::new(0x5678u16)];
/// let uninit_bytes = MaybeUninit::slice_as_bytes(&uninit);
/// let bytes = unsafe { MaybeUninit::slice_assume_init_ref(&uninit_bytes) };
/// let val1 = u16::from_ne_bytes(bytes[0..2].try_into().unwrap());
/// let val2 = u16::from_ne_bytes(bytes[2..4].try_into().unwrap());
/// assert_eq!(&[val1, val2], &[0x1234u16, 0x5678u16]);
/// ```
///
#[unstable(feature = "maybe_uninit_as_bytes", issue = "93092")]
pub fn slice_as_bytes(this: &[MaybeUninit<T>]) -> &[MaybeUninit<u8>] {
let bytes = mem::size_of_val(this);
// SAFETY: MaybeUninit<u8> 始终有效,即使对于填充字节也是如此
unsafe { slice::from_raw_parts(this.as_ptr() as *const MaybeUninit<u8>, bytes) }
}
/// 将 `MaybeUninit` 的可变切片的内容作为可能未初始化字节的可变切片返回。
///
/// 请注意,即使 `MaybeUninit` 的内容已初始化,该值仍可能包含未初始化的填充字节。
///
///
/// # Examples
///
/// ```
/// #![feature(maybe_uninit_as_bytes, maybe_uninit_write_slice, maybe_uninit_slice)]
/// use std::mem::MaybeUninit;
///
/// let mut uninit = [MaybeUninit::<u16>::uninit(), MaybeUninit::<u16>::uninit()];
/// let uninit_bytes = MaybeUninit::slice_as_bytes_mut(&mut uninit);
/// MaybeUninit::write_slice(uninit_bytes, &[0x12, 0x34, 0x56, 0x78]);
/// let vals = unsafe { MaybeUninit::slice_assume_init_ref(&uninit) };
/// if cfg!(target_endian = "little") {
/// assert_eq!(vals, &[0x3412u16, 0x7856u16]);
/// } else {
/// assert_eq!(vals, &[0x1234u16, 0x5678u16]);
/// }
/// ```
///
#[unstable(feature = "maybe_uninit_as_bytes", issue = "93092")]
pub fn slice_as_bytes_mut(this: &mut [MaybeUninit<T>]) -> &mut [MaybeUninit<u8>] {
let bytes = mem::size_of_val(this);
// SAFETY: MaybeUninit<u8> 始终有效,即使对于填充字节也是如此
unsafe { slice::from_raw_parts_mut(this.as_mut_ptr() as *mut MaybeUninit<u8>, bytes) }
}
}
impl<T, const N: usize> MaybeUninit<[T; N]> {
/// 将 `MaybeUninit<[T; N]>` 移调为 `[MaybeUninit<T>; N]`。
///
/// # Examples
///
/// ```
/// #![feature(maybe_uninit_uninit_array_transpose)]
/// # use std::mem::MaybeUninit;
///
/// let data: [MaybeUninit<u8>; 1000] = MaybeUninit::uninit().transpose();
/// ```
#[unstable(feature = "maybe_uninit_uninit_array_transpose", issue = "96097")]
#[inline]
pub const fn transpose(self) -> [MaybeUninit<T>; N] {
// SAFETY: T 和 MaybeUninit<T> 布局相同
unsafe { intrinsics::transmute_unchecked(self) }
}
}
impl<T, const N: usize> [MaybeUninit<T>; N] {
/// 将 `[MaybeUninit<T>; N]` 移调为 `MaybeUninit<[T; N]>`。
///
/// # Examples
///
/// ```
/// #![feature(maybe_uninit_uninit_array_transpose)]
/// # use std::mem::MaybeUninit;
///
/// let data = [MaybeUninit::<u8>::uninit(); 1000];
/// let data: MaybeUninit<[u8; 1000]> = data.transpose();
/// ```
#[unstable(feature = "maybe_uninit_uninit_array_transpose", issue = "96097")]
#[inline]
pub const fn transpose(self) -> MaybeUninit<[T; N]> {
// SAFETY: T 和 MaybeUninit<T> 布局相同
unsafe { intrinsics::transmute_unchecked(self) }
}
}