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
use crate::{UChar, UStr, WideChar}; use core::{ borrow::Borrow, char, cmp, mem::ManuallyDrop, ops::{Deref, Index, RangeFull}, slice, }; #[cfg(all(feature = "alloc", not(feature = "std")))] use alloc::{ borrow::{Cow, ToOwned}, boxed::Box, string::String, vec::Vec, }; #[cfg(feature = "std")] use std::{ borrow::{Cow, ToOwned}, boxed::Box, string::String, vec::Vec, }; /// An owned, mutable "wide" string for FFI that is **not** nul-aware. /// /// `UString` is not aware of nul values. Strings may or may not be nul-terminated, and may /// contain invalid and ill-formed UTF-16 or UTF-32 data. These strings are intended to be used /// with FFI functions that directly use string length, where the strings are known to have proper /// nul-termination already, or where strings are merely being passed through without modification. /// /// `UCString` should be used instead if nul-aware strings are required. /// /// `UString` can be converted to and from many other standard Rust string types, including /// `OsString` and `String`, making proper Unicode FFI safe and easy. /// /// Please prefer using the type aliases `U16String` or `U32String` or `WideString` to using this /// type directly. /// /// # Examples /// /// The following example constructs a `U16String` and shows how to convert a `U16String` to a /// regular Rust `String`. /// /// ```rust /// use widestring::U16String; /// let s = "Test"; /// // Create a wide string from the rust string /// let wstr = U16String::from_str(s); /// // Convert back to a rust string /// let rust_str = wstr.to_string_lossy(); /// assert_eq!(rust_str, "Test"); /// ``` /// /// The same example using `U32String` instead: /// /// ```rust /// use widestring::U32String; /// let s = "Test"; /// // Create a wide string from the rust string /// let wstr = U32String::from_str(s); /// // Convert back to a rust string /// let rust_str = wstr.to_string_lossy(); /// assert_eq!(rust_str, "Test"); /// ``` #[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct UString<C: UChar> { pub(crate) inner: Vec<C>, } impl<C: UChar> UString<C> { /// Constructs a new empty `UString`. pub fn new() -> Self { Self { inner: Vec::new() } } /// Constructs a `UString` from a vector of possibly invalid or ill-formed UTF-16 or UTF-32 /// data. /// /// No checks are made on the contents of the vector. /// /// # Examples /// /// ```rust /// use widestring::U16String; /// let v = vec![84u16, 104u16, 101u16]; // 'T' 'h' 'e' /// # let cloned = v.clone(); /// // Create a wide string from the vector /// let wstr = U16String::from_vec(v); /// # assert_eq!(wstr.into_vec(), cloned); /// ``` /// /// ```rust /// use widestring::U32String; /// let v = vec![84u32, 104u32, 101u32]; // 'T' 'h' 'e' /// # let cloned = v.clone(); /// // Create a wide string from the vector /// let wstr = U32String::from_vec(v); /// # assert_eq!(wstr.into_vec(), cloned); /// ``` pub fn from_vec(raw: impl Into<Vec<C>>) -> Self { Self { inner: raw.into() } } /// Constructs a `UString` from a pointer and a length. /// /// The `len` argument is the number of elements, **not** the number of bytes. /// /// # Safety /// /// This function is unsafe as there is no guarantee that the given pointer is valid for `len` /// elements. /// /// # Panics /// /// Panics if `len` is greater than 0 but `p` is a null pointer. pub unsafe fn from_ptr(p: *const C, len: usize) -> Self { if len == 0 { return Self::new(); } assert!(!p.is_null()); let slice = slice::from_raw_parts(p, len); Self::from_vec(slice) } /// Creates a `UString` with the given capacity. /// /// The string will be able to hold exactly `capacity` partial code units without reallocating. /// If `capacity` is set to 0, the string will not initially allocate. pub fn with_capacity(capacity: usize) -> Self { Self { inner: Vec::with_capacity(capacity), } } /// Returns the capacity this `UString` can hold without reallocating. pub fn capacity(&self) -> usize { self.inner.capacity() } /// Truncate the `UString` to zero length. pub fn clear(&mut self) { self.inner.clear() } /// Reserves the capacity for at least `additional` more capacity to be inserted in the given /// `UString`. /// /// More space may be reserved to avoid frequent allocations. pub fn reserve(&mut self, additional: usize) { self.inner.reserve(additional) } /// Reserves the minimum capacity for exactly `additional` more capacity to be inserted in the /// given `UString`. Does nothing if the capcity is already sufficient. /// /// Note that the allocator may give more space than is requested. Therefore capacity can not /// be relied upon to be precisely minimal. Prefer `reserve` if future insertions are expected. pub fn reserve_exact(&mut self, additional: usize) { self.inner.reserve_exact(additional) } /// Converts the wide string into a `Vec`, consuming the string in the process. pub fn into_vec(self) -> Vec<C> { self.inner } /// Converts to a `UStr` reference. pub fn as_ustr(&self) -> &UStr<C> { self } /// Extends the wide string with the given `&UStr`. /// /// No checks are performed on the strings. It is possible to end up nul values inside the /// string, and it is up to the caller to determine if that is acceptable. /// /// # Examples /// /// ```rust /// use widestring::U16String; /// let s = "MyString"; /// let mut wstr = U16String::from_str(s); /// let cloned = wstr.clone(); /// // Push the clone to the end, repeating the string twice. /// wstr.push(cloned); /// /// assert_eq!(wstr.to_string().unwrap(), "MyStringMyString"); /// ``` /// /// ```rust /// use widestring::U32String; /// let s = "MyString"; /// let mut wstr = U32String::from_str(s); /// let cloned = wstr.clone(); /// // Push the clone to the end, repeating the string twice. /// wstr.push(cloned); /// /// assert_eq!(wstr.to_string().unwrap(), "MyStringMyString"); /// ``` pub fn push(&mut self, s: impl AsRef<UStr<C>>) { self.inner.extend_from_slice(&s.as_ref().inner) } /// Extends the wide string with the given slice. /// /// No checks are performed on the strings. It is possible to end up nul values inside the /// string, and it is up to the caller to determine if that is acceptable. /// /// # Examples /// /// ```rust /// use widestring::U16String; /// let s = "MyString"; /// let mut wstr = U16String::from_str(s); /// let cloned = wstr.clone(); /// // Push the clone to the end, repeating the string twice. /// wstr.push_slice(cloned); /// /// assert_eq!(wstr.to_string().unwrap(), "MyStringMyString"); /// ``` /// /// ```rust /// use widestring::U32String; /// let s = "MyString"; /// let mut wstr = U32String::from_str(s); /// let cloned = wstr.clone(); /// // Push the clone to the end, repeating the string twice. /// wstr.push_slice(cloned); /// /// assert_eq!(wstr.to_string().unwrap(), "MyStringMyString"); /// ``` pub fn push_slice(&mut self, s: impl AsRef<[C]>) { self.inner.extend_from_slice(&s.as_ref()) } /// Shrinks the capacity of the `UString` to match its length. /// /// # Examples /// /// ```rust /// use widestring::U16String; /// /// let mut s = U16String::from_str("foo"); /// /// s.reserve(100); /// assert!(s.capacity() >= 100); /// /// s.shrink_to_fit(); /// assert_eq!(3, s.capacity()); /// ``` /// /// ```rust /// use widestring::U32String; /// /// let mut s = U32String::from_str("foo"); /// /// s.reserve(100); /// assert!(s.capacity() >= 100); /// /// s.shrink_to_fit(); /// assert_eq!(3, s.capacity()); /// ``` pub fn shrink_to_fit(&mut self) { self.inner.shrink_to_fit(); } /// Converts this `UString` into a boxed `UStr`. /// /// # Examples /// /// ``` /// use widestring::{U16String, U16Str}; /// /// let s = U16String::from_str("hello"); /// /// let b: Box<U16Str> = s.into_boxed_ustr(); /// ``` /// /// ``` /// use widestring::{U32String, U32Str}; /// /// let s = U32String::from_str("hello"); /// /// let b: Box<U32Str> = s.into_boxed_ustr(); /// ``` pub fn into_boxed_ustr(self) -> Box<UStr<C>> { let rw = Box::into_raw(self.inner.into_boxed_slice()) as *mut UStr<C>; unsafe { Box::from_raw(rw) } } } impl UString<u16> { /// Encodes a `U16String` copy from a `str`. /// /// This makes a wide string copy of the `str`. Since `str` will always be valid UTF-8, the /// resulting `U16String` will also be valid UTF-16. /// /// # Examples /// /// ```rust /// use widestring::U16String; /// let s = "MyString"; /// // Create a wide string from the string /// let wstr = U16String::from_str(s); /// /// assert_eq!(wstr.to_string().unwrap(), s); /// ``` #[allow(clippy::should_implement_trait)] pub fn from_str<S: AsRef<str> + ?Sized>(s: &S) -> Self { Self { inner: s.as_ref().encode_utf16().collect(), } } /// Encodes a `U16String` copy from an `OsStr`. /// /// This makes a wide string copy of the `OsStr`. Since `OsStr` makes no guarantees that it is /// valid data, there is no guarantee that the resulting `U16String` will be valid UTF-16. /// /// # Examples /// /// ```rust /// use widestring::U16String; /// let s = "MyString"; /// // Create a wide string from the string /// let wstr = U16String::from_os_str(s); /// /// assert_eq!(wstr.to_string().unwrap(), s); /// ``` #[cfg(feature = "std")] pub fn from_os_str<S: AsRef<std::ffi::OsStr> + ?Sized>(s: &S) -> Self { Self { inner: crate::platform::os_to_wide(s.as_ref()), } } /// Extends the string with the given `&str`. /// /// No checks are performed on the strings. It is possible to end up nul values inside the /// string, and it is up to the caller to determine if that is acceptable. /// /// # Examples /// /// ```rust /// use widestring::U16String; /// let s = "MyString"; /// let mut wstr = U16String::from_str(s); /// // Push the original to the end, repeating the string twice. /// wstr.push_str(s); /// /// assert_eq!(wstr.to_string().unwrap(), "MyStringMyString"); /// ``` pub fn push_str(&mut self, s: impl AsRef<str>) { self.inner.extend(s.as_ref().encode_utf16()) } /// Extends the string with the given `&OsStr`. /// /// No checks are performed on the strings. It is possible to end up nul values inside the /// string, and it is up to the caller to determine if that is acceptable. /// /// # Examples /// /// ```rust /// use widestring::U16String; /// let s = "MyString"; /// let mut wstr = U16String::from_str(s); /// // Push the original to the end, repeating the string twice. /// wstr.push_os_str(s); /// /// assert_eq!(wstr.to_string().unwrap(), "MyStringMyString"); /// ``` #[cfg(feature = "std")] pub fn push_os_str(&mut self, s: impl AsRef<std::ffi::OsStr>) { self.inner.extend(crate::platform::os_to_wide(s.as_ref())) } } impl UString<u32> { /// Constructs a `U32String` from a vector of UTF-32 data. /// /// No checks are made on the contents of the vector. /// /// # Examples /// /// ```rust /// use widestring::U32String; /// let v: Vec<char> = "Test".chars().collect(); /// # let cloned: Vec<u32> = v.iter().map(|&c| c as u32).collect(); /// // Create a wide string from the vector /// let wstr = U32String::from_chars(v); /// # assert_eq!(wstr.into_vec(), cloned); /// ``` pub fn from_chars(raw: impl Into<Vec<char>>) -> Self { let mut chars = raw.into(); UString { inner: unsafe { let ptr = chars.as_mut_ptr() as *mut u32; let len = chars.len(); let cap = chars.capacity(); ManuallyDrop::new(chars); Vec::from_raw_parts(ptr, len, cap) }, } } /// Encodes a `U32String` copy from a `str`. /// /// This makes a wide string copy of the `str`. Since `str` will always be valid UTF-8, the /// resulting `U32String` will also be valid UTF-32. /// /// # Examples /// /// ```rust /// use widestring::U32String; /// let s = "MyString"; /// // Create a wide string from the string /// let wstr = U32String::from_str(s); /// /// assert_eq!(wstr.to_string().unwrap(), s); /// ``` #[allow(clippy::should_implement_trait)] pub fn from_str<S: AsRef<str> + ?Sized>(s: &S) -> Self { let v: Vec<char> = s.as_ref().chars().collect(); UString::from_chars(v) } /// Encodes a `U32String` copy from an `OsStr`. /// /// This makes a wide string copy of the `OsStr`. Since `OsStr` makes no guarantees that it is /// valid data, there is no guarantee that the resulting `U32String` will be valid UTF-32. /// /// # Examples /// /// ```rust /// use widestring::U32String; /// let s = "MyString"; /// // Create a wide string from the string /// let wstr = U32String::from_os_str(s); /// /// assert_eq!(wstr.to_string().unwrap(), s); /// ``` #[cfg(feature = "std")] pub fn from_os_str<S: AsRef<std::ffi::OsStr> + ?Sized>(s: &S) -> Self { let v: Vec<char> = s.as_ref().to_string_lossy().chars().collect(); UString::from_chars(v) } /// Constructs a `U32String` from a `char` pointer and a length. /// /// The `len` argument is the number of `char` elements, **not** the number of bytes. /// /// # Safety /// /// This function is unsafe as there is no guarantee that the given pointer is valid for `len` /// elements. /// /// # Panics /// /// Panics if `len` is greater than 0 but `p` is a null pointer. pub unsafe fn from_char_ptr(p: *const char, len: usize) -> Self { UString::from_ptr(p as *const u32, len) } /// Extends the string with the given `&str`. /// /// No checks are performed on the strings. It is possible to end up nul values inside the /// string, and it is up to the caller to determine if that is acceptable. /// /// # Examples /// /// ```rust /// use widestring::U32String; /// let s = "MyString"; /// let mut wstr = U32String::from_str(s); /// // Push the original to the end, repeating the string twice. /// wstr.push_str(s); /// /// assert_eq!(wstr.to_string().unwrap(), "MyStringMyString"); /// ``` pub fn push_str(&mut self, s: impl AsRef<str>) { self.inner.extend(s.as_ref().chars().map(|c| c as u32)) } /// Extends the string with the given `&OsStr`. /// /// No checks are performed on the strings. It is possible to end up nul values inside the /// string, and it is up to the caller to determine if that is acceptable. /// /// # Examples /// /// ```rust /// use widestring::U32String; /// let s = "MyString"; /// let mut wstr = U32String::from_str(s); /// // Push the original to the end, repeating the string twice. /// wstr.push_os_str(s); /// /// assert_eq!(wstr.to_string().unwrap(), "MyStringMyString"); /// ``` #[cfg(feature = "std")] pub fn push_os_str(&mut self, s: impl AsRef<std::ffi::OsStr>) { self.inner .extend(s.as_ref().to_string_lossy().chars().map(|c| c as u32)) } } impl<C: UChar> Into<Vec<C>> for UString<C> { fn into(self) -> Vec<C> { self.into_vec() } } impl<'a> From<UString<u16>> for Cow<'a, UStr<u16>> { fn from(s: UString<u16>) -> Self { Cow::Owned(s) } } impl<'a> From<UString<u32>> for Cow<'a, UStr<u32>> { fn from(s: UString<u32>) -> Self { Cow::Owned(s) } } impl Into<UString<u16>> for Vec<u16> { fn into(self) -> UString<u16> { UString::from_vec(self) } } impl Into<UString<u32>> for Vec<u32> { fn into(self) -> UString<u32> { UString::from_vec(self) } } impl Into<UString<u32>> for Vec<char> { fn into(self) -> UString<u32> { UString::from_chars(self) } } impl From<String> for UString<u16> { fn from(s: String) -> Self { Self::from_str(&s) } } impl From<String> for UString<u32> { fn from(s: String) -> Self { Self::from_str(&s) } } #[cfg(feature = "std")] impl From<std::ffi::OsString> for UString<u16> { fn from(s: std::ffi::OsString) -> Self { Self::from_os_str(&s) } } #[cfg(feature = "std")] impl From<std::ffi::OsString> for UString<u32> { fn from(s: std::ffi::OsString) -> Self { Self::from_os_str(&s) } } #[cfg(feature = "std")] impl From<UString<u16>> for std::ffi::OsString { fn from(s: UString<u16>) -> Self { s.to_os_string() } } #[cfg(feature = "std")] impl From<UString<u32>> for std::ffi::OsString { fn from(s: UString<u32>) -> Self { s.to_os_string() } } impl<'a, C: UChar, T: ?Sized + AsRef<UStr<C>>> From<&'a T> for UString<C> { fn from(s: &'a T) -> Self { s.as_ref().to_ustring() } } impl<C: UChar> Index<RangeFull> for UString<C> { type Output = UStr<C>; #[inline] fn index(&self, _index: RangeFull) -> &UStr<C> { UStr::from_slice(&self.inner) } } impl<C: UChar> Deref for UString<C> { type Target = UStr<C>; #[inline] fn deref(&self) -> &UStr<C> { &self[..] } } impl<C: UChar> PartialEq<UStr<C>> for UString<C> { #[inline] fn eq(&self, other: &UStr<C>) -> bool { self.as_ustr() == other } } impl<C: UChar> PartialOrd<UStr<C>> for UString<C> { #[inline] fn partial_cmp(&self, other: &UStr<C>) -> Option<cmp::Ordering> { self.as_ustr().partial_cmp(other) } } impl<'a, C: UChar> PartialEq<&'a UStr<C>> for UString<C> { #[inline] fn eq(&self, other: &&'a UStr<C>) -> bool { self.as_ustr() == *other } } impl<'a, C: UChar> PartialOrd<&'a UStr<C>> for UString<C> { #[inline] fn partial_cmp(&self, other: &&'a UStr<C>) -> Option<cmp::Ordering> { self.as_ustr().partial_cmp(*other) } } impl<'a, C: UChar> PartialEq<Cow<'a, UStr<C>>> for UString<C> { #[inline] fn eq(&self, other: &Cow<'a, UStr<C>>) -> bool { self.as_ustr() == other.as_ref() } } impl<'a, C: UChar> PartialOrd<Cow<'a, UStr<C>>> for UString<C> { #[inline] fn partial_cmp(&self, other: &Cow<'a, UStr<C>>) -> Option<cmp::Ordering> { self.as_ustr().partial_cmp(other.as_ref()) } } impl<C: UChar> Borrow<UStr<C>> for UString<C> { fn borrow(&self) -> &UStr<C> { &self[..] } } impl<C: UChar> ToOwned for UStr<C> { type Owned = UString<C>; fn to_owned(&self) -> UString<C> { self.to_ustring() } } impl<'a> From<&'a UStr<u16>> for Cow<'a, UStr<u16>> { fn from(s: &'a UStr<u16>) -> Self { Cow::Borrowed(s) } } impl<'a> From<&'a UStr<u32>> for Cow<'a, UStr<u32>> { fn from(s: &'a UStr<u32>) -> Self { Cow::Borrowed(s) } } impl<C: UChar> AsRef<UStr<C>> for UStr<C> { fn as_ref(&self) -> &Self { self } } impl<C: UChar> AsRef<UStr<C>> for UString<C> { fn as_ref(&self) -> &UStr<C> { self } } impl<C: UChar> AsRef<[C]> for UStr<C> { fn as_ref(&self) -> &[C] { self.as_slice() } } impl<C: UChar> AsRef<[C]> for UString<C> { fn as_ref(&self) -> &[C] { self.as_slice() } } impl<'a, C: UChar> From<&'a UStr<C>> for Box<UStr<C>> { fn from(s: &'a UStr<C>) -> Self { let boxed: Box<[C]> = Box::from(&s.inner); let rw = Box::into_raw(boxed) as *mut UStr<C>; unsafe { Box::from_raw(rw) } } } impl<C: UChar> From<Box<UStr<C>>> for UString<C> { fn from(boxed: Box<UStr<C>>) -> Self { boxed.into_ustring() } } impl<C: UChar> From<UString<C>> for Box<UStr<C>> { fn from(s: UString<C>) -> Self { s.into_boxed_ustr() } } impl<C: UChar> Default for Box<UStr<C>> { fn default() -> Self { let boxed: Box<[C]> = Box::from([]); let rw = Box::into_raw(boxed) as *mut UStr<C>; unsafe { Box::from_raw(rw) } } } /// An owned, mutable "wide" string for FFI that is **not** nul-aware. /// /// `U16String` is not aware of nul values. Strings may or may not be nul-terminated, and may /// contain invalid and ill-formed UTF-16 data. These strings are intended to be used with /// FFI functions that directly use string length, where the strings are known to have proper /// nul-termination already, or where strings are merely being passed through without modification. /// /// `WideCString` should be used instead if nul-aware strings are required. /// /// `U16String` can be converted to and from many other standard Rust string types, including /// `OsString` and `String`, making proper Unicode FFI safe and easy. /// /// # Examples /// /// The following example constructs a `U16String` and shows how to convert a `U16String` to a /// regular Rust `String`. /// /// ```rust /// use widestring::U16String; /// let s = "Test"; /// // Create a wide string from the rust string /// let wstr = U16String::from_str(s); /// // Convert back to a rust string /// let rust_str = wstr.to_string_lossy(); /// assert_eq!(rust_str, "Test"); /// ``` pub type U16String = UString<u16>; /// An owned, mutable 32-bit wide string for FFI that is **not** nul-aware. /// /// `U32String` is not aware of nul values. Strings may or may not be nul-terminated, and may /// contain invalid and ill-formed UTF-32 data. These strings are intended to be used with /// FFI functions that directly use string length, where the strings are known to have proper /// nul-termination already, or where strings are merely being passed through without modification. /// /// `U32CString` should be used instead if nul-aware 32-bit strings are required. /// /// `U32String` can be converted to and from many other standard Rust string types, including /// `OsString` and `String`, making proper Unicode FFI safe and easy. /// /// # Examples /// /// The following example constructs a `U32String` and shows how to convert a `U32String` to a /// regular Rust `String`. /// /// ```rust /// use widestring::U32String; /// let s = "Test"; /// // Create a wide string from the rust string /// let wstr = U32String::from_str(s); /// // Convert back to a rust string /// let rust_str = wstr.to_string_lossy(); /// assert_eq!(rust_str, "Test"); /// ``` pub type U32String = UString<u32>; /// Alias for `U16String` or `U32String` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideString = UString<WideChar>;