facet-value 0.46.0

Memory-efficient dynamic value type for facet, supporting JSON-like data plus bytes
Documentation
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
//! String value type.

use crate::value::{TypeTag, Value};
#[cfg(feature = "alloc")]
use alloc::alloc::{Layout, alloc, dealloc};
#[cfg(feature = "alloc")]
use alloc::string::String;
use core::borrow::Borrow;
use core::cmp::Ordering;
use core::fmt::{self, Debug, Formatter};
use core::hash::{Hash, Hasher};
use core::mem;
use core::ops::Deref;
use core::ptr;

/// Flag indicating the string is marked as "safe" (e.g., pre-escaped HTML).
/// This uses the high bit of the length field in StringHeader.
const SAFE_FLAG: usize = 1usize << (usize::BITS - 1);

/// Header for heap-allocated strings.
#[repr(C, align(8))]
struct StringHeader {
    /// Length of the string in bytes.
    /// The high bit may be set to indicate a "safe" string (see SAFE_FLAG).
    len: usize,
    // String data follows immediately after
}

impl StringHeader {
    /// Returns the actual length of the string, masking out the safe flag.
    #[inline]
    const fn actual_len(&self) -> usize {
        self.len & !SAFE_FLAG
    }

    /// Returns true if the safe flag is set.
    #[inline]
    const fn is_safe(&self) -> bool {
        self.len & SAFE_FLAG != 0
    }
}

/// A string value.
///
/// `VString` stores UTF-8 string data. Short strings (up to 7 bytes on 64-bit targets) are
/// embedded directly in the `Value` pointer bits, while longer strings fall back to heap storage.
#[repr(transparent)]
#[derive(Clone)]
pub struct VString(pub(crate) Value);

impl VString {
    const INLINE_WORD_BYTES: usize = mem::size_of::<usize>();
    const INLINE_DATA_OFFSET: usize = 1;
    const INLINE_CAP_BYTES: usize = Self::INLINE_WORD_BYTES - Self::INLINE_DATA_OFFSET;
    pub(crate) const INLINE_LEN_MAX: usize = {
        const LEN_MASK: usize = (1 << (8 - 3)) - 1;
        let cap = mem::size_of::<usize>() - 1;
        if cap < LEN_MASK { cap } else { LEN_MASK }
    };
    const INLINE_LEN_SHIFT: u8 = 3;

    fn layout(len: usize) -> Layout {
        Layout::new::<StringHeader>()
            .extend(Layout::array::<u8>(len).unwrap())
            .unwrap()
            .0
            .pad_to_align()
    }

    #[cfg(feature = "alloc")]
    fn alloc(s: &str) -> *mut StringHeader {
        unsafe {
            let layout = Self::layout(s.len());
            let ptr = alloc(layout).cast::<StringHeader>();
            (*ptr).len = s.len();

            // Copy string data
            let data_ptr = ptr.add(1).cast::<u8>();
            ptr::copy_nonoverlapping(s.as_ptr(), data_ptr, s.len());

            ptr
        }
    }

    #[cfg(feature = "alloc")]
    fn dealloc_ptr(ptr: *mut StringHeader) {
        unsafe {
            let len = (*ptr).actual_len();
            let layout = Self::layout(len);
            dealloc(ptr.cast::<u8>(), layout);
        }
    }

    fn header(&self) -> &StringHeader {
        debug_assert!(!self.is_inline());
        unsafe { &*(self.0.heap_ptr() as *const StringHeader) }
    }

    fn data_ptr(&self) -> *const u8 {
        debug_assert!(!self.is_inline());
        // Go through heap_ptr directly to avoid creating intermediate reference
        // that would limit provenance to just the header
        unsafe { (self.0.heap_ptr() as *const StringHeader).add(1).cast() }
    }

    /// Creates a new string from a `&str`.
    #[cfg(feature = "alloc")]
    #[must_use]
    pub fn new(s: &str) -> Self {
        if Self::can_inline(s.len()) {
            return Self::new_inline(s);
        }
        unsafe {
            let ptr = Self::alloc(s);
            VString(Value::new_ptr(ptr.cast(), TypeTag::StringOrNull))
        }
    }

    /// Creates an empty string.
    #[cfg(feature = "alloc")]
    #[must_use]
    pub fn empty() -> Self {
        Self::new_inline("")
    }

    /// Returns the length of the string in bytes.
    #[must_use]
    pub fn len(&self) -> usize {
        if self.is_inline() {
            self.inline_len()
        } else {
            self.header().actual_len()
        }
    }

    /// Returns `true` if the string is empty.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Returns the string as a `&str`.
    #[must_use]
    pub fn as_str(&self) -> &str {
        unsafe { core::str::from_utf8_unchecked(self.as_bytes()) }
    }

    /// Returns the string as a byte slice.
    #[must_use]
    pub fn as_bytes(&self) -> &[u8] {
        if self.is_inline() {
            unsafe { core::slice::from_raw_parts(self.inline_data_ptr(), self.inline_len()) }
        } else {
            unsafe { core::slice::from_raw_parts(self.data_ptr(), self.len()) }
        }
    }

    pub(crate) fn clone_impl(&self) -> Value {
        if self.is_safe() {
            // Preserve the safe flag through clone
            VSafeString::new(self.as_str()).0
        } else {
            VString::new(self.as_str()).0
        }
    }

    pub(crate) fn drop_impl(&mut self) {
        if self.is_inline() {
            return;
        }
        unsafe {
            Self::dealloc_ptr(self.0.heap_ptr_mut().cast());
        }
    }

    #[inline]
    fn is_inline(&self) -> bool {
        self.0.is_inline_string()
    }

    #[inline]
    const fn can_inline(len: usize) -> bool {
        len <= Self::INLINE_LEN_MAX && len <= Self::INLINE_CAP_BYTES
    }

    #[inline]
    const fn inline_meta_ptr(&self) -> *const u8 {
        self as *const VString as *const u8
    }

    #[inline]
    const fn inline_data_ptr(&self) -> *const u8 {
        unsafe { self.inline_meta_ptr().add(Self::INLINE_DATA_OFFSET) }
    }

    #[inline]
    fn inline_len(&self) -> usize {
        debug_assert!(self.is_inline());
        unsafe { (*self.inline_meta_ptr() >> Self::INLINE_LEN_SHIFT) as usize }
    }

    #[cfg(feature = "alloc")]
    fn new_inline(s: &str) -> Self {
        debug_assert!(Self::can_inline(s.len()));
        let mut storage = [0u8; Self::INLINE_WORD_BYTES];
        storage[0] = ((s.len() as u8) << Self::INLINE_LEN_SHIFT) | (TypeTag::InlineString as u8);
        storage[Self::INLINE_DATA_OFFSET..Self::INLINE_DATA_OFFSET + s.len()]
            .copy_from_slice(s.as_bytes());
        let bits = usize::from_ne_bytes(storage);
        VString(unsafe { Value::from_bits(bits) })
    }

    /// Allocate a heap string with the safe flag set.
    #[cfg(feature = "alloc")]
    fn alloc_safe(s: &str) -> *mut StringHeader {
        unsafe {
            let layout = Self::layout(s.len());
            let ptr = alloc(layout).cast::<StringHeader>();
            (*ptr).len = s.len() | SAFE_FLAG;

            // Copy string data
            let data_ptr = ptr.add(1).cast::<u8>();
            ptr::copy_nonoverlapping(s.as_ptr(), data_ptr, s.len());

            ptr
        }
    }

    /// Returns `true` if this string is marked as safe (e.g., pre-escaped HTML).
    ///
    /// Inline strings are never safe - only heap-allocated strings can carry the safe flag.
    #[must_use]
    pub fn is_safe(&self) -> bool {
        if self.is_inline() {
            false
        } else {
            self.header().is_safe()
        }
    }

    /// Converts this string into a safe string.
    ///
    /// If the string is already safe, returns the same string wrapped as VSafeString.
    /// If the string is inline, promotes it to heap storage with the safe flag.
    /// If the string is on the heap but not safe, reallocates with the safe flag set.
    #[cfg(feature = "alloc")]
    #[must_use]
    pub fn into_safe(self) -> VSafeString {
        if self.is_safe() {
            // Already safe, just wrap it
            return VSafeString(self.0);
        }
        // Need to allocate (or reallocate) with safe flag
        let s = self.as_str();
        unsafe {
            let ptr = Self::alloc_safe(s);
            VSafeString(Value::new_ptr(ptr.cast(), TypeTag::StringOrNull))
        }
    }
}

const _: () = {
    assert!(VString::INLINE_DATA_OFFSET == 1);
    assert!(VString::INLINE_CAP_BYTES <= VString::INLINE_WORD_BYTES - VString::INLINE_DATA_OFFSET);
    assert!(VString::INLINE_LEN_MAX <= VString::INLINE_CAP_BYTES);
};

/// A string value marked as "safe" (e.g., pre-escaped HTML that should not be escaped again).
///
/// `VSafeString` is semantically a string, but carries a flag indicating it has already been
/// processed (e.g., HTML-escaped) and should be output verbatim by template engines.
///
/// Unlike regular strings, safe strings are always heap-allocated since inline strings
/// don't have room for the safe flag.
///
/// # Example use case
///
/// ```ignore
/// // In a template engine:
/// {{ page.content }}           // If VSafeString, output as-is
/// {{ user_input }}             // Regular VString, escape HTML
/// {{ user_input | safe }}      // Convert to VSafeString via into_safe()
/// ```
#[repr(transparent)]
#[derive(Clone)]
pub struct VSafeString(pub(crate) Value);

impl VSafeString {
    /// Creates a new safe string from a `&str`.
    ///
    /// This always heap-allocates, even for short strings, since the safe flag
    /// is stored in the heap header.
    #[cfg(feature = "alloc")]
    #[must_use]
    pub fn new(s: &str) -> Self {
        unsafe {
            let ptr = VString::alloc_safe(s);
            VSafeString(Value::new_ptr(ptr.cast(), TypeTag::StringOrNull))
        }
    }

    /// Returns the length of the string in bytes.
    #[must_use]
    pub fn len(&self) -> usize {
        // Safe strings are never inline, so we can go directly to the header
        self.header().actual_len()
    }

    /// Returns `true` if the string is empty.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Returns the string as a `&str`.
    #[must_use]
    pub fn as_str(&self) -> &str {
        unsafe { core::str::from_utf8_unchecked(self.as_bytes()) }
    }

    /// Returns the string as a byte slice.
    #[must_use]
    pub fn as_bytes(&self) -> &[u8] {
        unsafe { core::slice::from_raw_parts(self.data_ptr(), self.len()) }
    }

    fn header(&self) -> &StringHeader {
        unsafe { &*(self.0.heap_ptr() as *const StringHeader) }
    }

    fn data_ptr(&self) -> *const u8 {
        unsafe { (self.0.heap_ptr() as *const StringHeader).add(1).cast() }
    }
}

impl Deref for VSafeString {
    type Target = str;

    fn deref(&self) -> &str {
        self.as_str()
    }
}

impl Borrow<str> for VSafeString {
    fn borrow(&self) -> &str {
        self.as_str()
    }
}

impl AsRef<str> for VSafeString {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl AsRef<[u8]> for VSafeString {
    fn as_ref(&self) -> &[u8] {
        self.as_bytes()
    }
}

impl PartialEq for VSafeString {
    fn eq(&self, other: &Self) -> bool {
        self.as_str() == other.as_str()
    }
}

impl Eq for VSafeString {}

impl PartialOrd for VSafeString {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for VSafeString {
    fn cmp(&self, other: &Self) -> Ordering {
        self.as_str().cmp(other.as_str())
    }
}

impl Hash for VSafeString {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.as_str().hash(state);
    }
}

impl Debug for VSafeString {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.debug_tuple("SafeString").field(&self.as_str()).finish()
    }
}

impl fmt::Display for VSafeString {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        fmt::Display::fmt(self.as_str(), f)
    }
}

// === PartialEq with str ===

impl PartialEq<str> for VSafeString {
    fn eq(&self, other: &str) -> bool {
        self.as_str() == other
    }
}

impl PartialEq<VSafeString> for str {
    fn eq(&self, other: &VSafeString) -> bool {
        self == other.as_str()
    }
}

impl PartialEq<&str> for VSafeString {
    fn eq(&self, other: &&str) -> bool {
        self.as_str() == *other
    }
}

#[cfg(feature = "alloc")]
impl PartialEq<String> for VSafeString {
    fn eq(&self, other: &String) -> bool {
        self.as_str() == other.as_str()
    }
}

#[cfg(feature = "alloc")]
impl PartialEq<VString> for VSafeString {
    fn eq(&self, other: &VString) -> bool {
        self.as_str() == other.as_str()
    }
}

#[cfg(feature = "alloc")]
impl PartialEq<VSafeString> for VString {
    fn eq(&self, other: &VSafeString) -> bool {
        self.as_str() == other.as_str()
    }
}

// === From implementations ===

#[cfg(feature = "alloc")]
impl From<&str> for VSafeString {
    fn from(s: &str) -> Self {
        Self::new(s)
    }
}

#[cfg(feature = "alloc")]
impl From<String> for VSafeString {
    fn from(s: String) -> Self {
        Self::new(&s)
    }
}

#[cfg(feature = "alloc")]
impl From<&String> for VSafeString {
    fn from(s: &String) -> Self {
        Self::new(s)
    }
}

#[cfg(feature = "alloc")]
impl From<VSafeString> for String {
    fn from(s: VSafeString) -> Self {
        s.as_str().into()
    }
}

// A safe string IS a string, so we can convert
impl From<VSafeString> for VString {
    fn from(s: VSafeString) -> Self {
        VString(s.0)
    }
}

// === Value conversions ===

impl AsRef<Value> for VSafeString {
    fn as_ref(&self) -> &Value {
        &self.0
    }
}

impl AsMut<Value> for VSafeString {
    fn as_mut(&mut self) -> &mut Value {
        &mut self.0
    }
}

impl From<VSafeString> for Value {
    fn from(s: VSafeString) -> Self {
        s.0
    }
}

impl VSafeString {
    /// Converts this VSafeString into a Value, consuming self.
    #[inline]
    pub fn into_value(self) -> Value {
        self.0
    }

    /// Converts this VSafeString into a VString, consuming self.
    /// The resulting VString will still have the safe flag set.
    #[inline]
    pub fn into_string(self) -> VString {
        VString(self.0)
    }
}

impl Deref for VString {
    type Target = str;

    fn deref(&self) -> &str {
        self.as_str()
    }
}

impl Borrow<str> for VString {
    fn borrow(&self) -> &str {
        self.as_str()
    }
}

impl AsRef<str> for VString {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl AsRef<[u8]> for VString {
    fn as_ref(&self) -> &[u8] {
        self.as_bytes()
    }
}

impl PartialEq for VString {
    fn eq(&self, other: &Self) -> bool {
        self.as_str() == other.as_str()
    }
}

impl Eq for VString {}

impl PartialOrd for VString {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for VString {
    fn cmp(&self, other: &Self) -> Ordering {
        self.as_str().cmp(other.as_str())
    }
}

impl Hash for VString {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.as_str().hash(state);
    }
}

impl Debug for VString {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        Debug::fmt(self.as_str(), f)
    }
}

impl fmt::Display for VString {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        fmt::Display::fmt(self.as_str(), f)
    }
}

impl Default for VString {
    fn default() -> Self {
        Self::empty()
    }
}

// === PartialEq with str ===

impl PartialEq<str> for VString {
    fn eq(&self, other: &str) -> bool {
        self.as_str() == other
    }
}

impl PartialEq<VString> for str {
    fn eq(&self, other: &VString) -> bool {
        self == other.as_str()
    }
}

impl PartialEq<&str> for VString {
    fn eq(&self, other: &&str) -> bool {
        self.as_str() == *other
    }
}

#[cfg(feature = "alloc")]
impl PartialEq<String> for VString {
    fn eq(&self, other: &String) -> bool {
        self.as_str() == other.as_str()
    }
}

#[cfg(feature = "alloc")]
impl PartialEq<VString> for String {
    fn eq(&self, other: &VString) -> bool {
        self.as_str() == other.as_str()
    }
}

// === From implementations ===

#[cfg(feature = "alloc")]
impl From<&str> for VString {
    fn from(s: &str) -> Self {
        Self::new(s)
    }
}

#[cfg(feature = "alloc")]
impl From<String> for VString {
    fn from(s: String) -> Self {
        Self::new(&s)
    }
}

#[cfg(feature = "alloc")]
impl From<&String> for VString {
    fn from(s: &String) -> Self {
        Self::new(s)
    }
}

#[cfg(feature = "alloc")]
impl From<VString> for String {
    fn from(s: VString) -> Self {
        s.as_str().into()
    }
}

// === Value conversions ===

impl AsRef<Value> for VString {
    fn as_ref(&self) -> &Value {
        &self.0
    }
}

impl AsMut<Value> for VString {
    fn as_mut(&mut self) -> &mut Value {
        &mut self.0
    }
}

impl From<VString> for Value {
    fn from(s: VString) -> Self {
        s.0
    }
}

impl VString {
    /// Converts this VString into a Value, consuming self.
    #[inline]
    pub fn into_value(self) -> Value {
        self.0
    }
}

#[cfg(feature = "alloc")]
impl From<&str> for Value {
    fn from(s: &str) -> Self {
        VString::new(s).0
    }
}

#[cfg(feature = "alloc")]
impl From<String> for Value {
    fn from(s: String) -> Self {
        VString::new(&s).0
    }
}

#[cfg(feature = "alloc")]
impl From<&String> for Value {
    fn from(s: &String) -> Self {
        VString::new(s).0
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::value::{TypeTag, Value};

    #[test]
    fn test_new() {
        let s = VString::new("hello");
        assert_eq!(s.as_str(), "hello");
        assert_eq!(s.len(), 5);
        assert!(!s.is_empty());
    }

    #[test]
    fn test_empty() {
        let s = VString::empty();
        assert_eq!(s.as_str(), "");
        assert_eq!(s.len(), 0);
        assert!(s.is_empty());
    }

    #[test]
    fn test_equality() {
        let a = VString::new("hello");
        let b = VString::new("hello");
        let c = VString::new("world");

        assert_eq!(a, b);
        assert_ne!(a, c);
        assert_eq!(a, "hello");
        assert_eq!(a.as_str(), "hello");
    }

    #[test]
    fn test_clone() {
        let a = VString::new("test");
        let b = a.clone();
        assert_eq!(a, b);
    }

    #[test]
    fn test_unicode() {
        let s = VString::new("hello 世界 🌍");
        assert_eq!(s.as_str(), "hello 世界 🌍");
    }

    #[test]
    fn test_deref() {
        let s = VString::new("hello");
        assert!(s.starts_with("hel"));
        assert!(s.ends_with("llo"));
    }

    #[test]
    fn test_ordering() {
        let a = VString::new("apple");
        let b = VString::new("banana");
        assert!(a < b);
    }

    #[test]
    fn test_inline_representation() {
        let s = VString::new("inline");
        assert!(s.is_inline(), "expected inline storage");
        assert_eq!(s.as_str(), "inline");
    }

    #[test]
    fn test_heap_representation() {
        let long_input = "a".repeat(VString::INLINE_LEN_MAX + 1);
        let s = VString::new(&long_input);
        assert!(!s.is_inline(), "expected heap storage");
        assert_eq!(s.as_str(), long_input);
    }

    #[test]
    fn inline_capacity_boundaries() {
        for len in 0..=VString::INLINE_LEN_MAX {
            let input = "x".repeat(len);
            let s = VString::new(&input);
            assert!(
                s.is_inline(),
                "expected inline storage for length {} (capacity {})",
                len,
                VString::INLINE_LEN_MAX
            );
            assert_eq!(s.len(), len);
            assert_eq!(s.as_str(), input);
            assert_eq!(s.as_bytes(), input.as_bytes());
        }

        let overflow = "y".repeat(VString::INLINE_LEN_MAX + 1);
        let heap = VString::new(&overflow);
        assert!(
            !heap.is_inline(),
            "length {} should force heap allocation",
            overflow.len()
        );
    }

    #[test]
    fn inline_value_tag_matches() {
        for len in 0..=VString::INLINE_LEN_MAX {
            let input = "z".repeat(len);
            let value = Value::from(input.as_str());
            assert!(value.is_inline_string(), "Value should mark inline string");
            assert_eq!(
                value.ptr_usize() & 0b111,
                TypeTag::InlineString as usize,
                "low bits must store inline string tag"
            );
            let roundtrip = value.as_string().expect("string value");
            assert_eq!(roundtrip.as_str(), input);
            assert_eq!(roundtrip.as_bytes(), input.as_bytes());
        }
    }

    #[cfg(target_pointer_width = "64")]
    #[test]
    fn inline_len_max_is_seven_on_64_bit() {
        assert_eq!(VString::INLINE_LEN_MAX, 7);
    }

    #[cfg(target_pointer_width = "32")]
    #[test]
    fn inline_len_max_is_three_on_32_bit() {
        assert_eq!(VString::INLINE_LEN_MAX, 3);
    }

    // === VSafeString tests ===

    #[test]
    fn test_safe_string_new() {
        let s = VSafeString::new("hello");
        assert_eq!(s.as_str(), "hello");
        assert_eq!(s.len(), 5);
        assert!(!s.is_empty());
    }

    #[test]
    fn test_safe_string_roundtrip() {
        let original = "<b>bold</b>";
        let safe = VSafeString::new(original);
        assert_eq!(safe.as_str(), original);
    }

    #[test]
    fn test_safe_string_is_always_heap() {
        // Even short strings should be heap-allocated for safe strings
        let short = VSafeString::new("hi");
        assert_eq!(short.len(), 2);
        assert_eq!(short.as_str(), "hi");
        // The value should have tag 1 (StringOrNull) not tag 6 (InlineString)
        let value: Value = short.into();
        assert!(!value.is_inline_string());
        assert!(value.is_string());
    }

    #[test]
    fn test_vstring_is_safe() {
        let normal = VString::new("hello");
        assert!(!normal.is_safe());

        let safe = VSafeString::new("hello");
        // When viewed as VString, should still report safe
        let as_vstring: VString = safe.into();
        assert!(as_vstring.is_safe());
    }

    #[test]
    fn test_vstring_into_safe() {
        // Test inline string promotion
        let inline = VString::new("hi");
        assert!(inline.is_inline());
        let safe = inline.into_safe();
        assert_eq!(safe.as_str(), "hi");

        // Test heap string conversion
        let long = "a".repeat(VString::INLINE_LEN_MAX + 10);
        let heap = VString::new(&long);
        assert!(!heap.is_inline());
        let safe_heap = heap.into_safe();
        assert_eq!(safe_heap.as_str(), long);
    }

    #[test]
    fn test_safe_flag_preserved_through_clone() {
        let safe = VSafeString::new("<b>bold</b>");
        let value: Value = safe.into();
        assert!(value.is_safe_string());

        let cloned = value.clone();
        assert!(cloned.is_safe_string());
        assert_eq!(cloned.as_string().unwrap().as_str(), "<b>bold</b>");
    }

    #[test]
    fn test_value_as_safe_string() {
        let safe = VSafeString::new("safe content");
        let value: Value = safe.into();

        // is_string should return true (safe strings ARE strings)
        assert!(value.is_string());
        // is_safe_string should also return true
        assert!(value.is_safe_string());
        // as_string should work
        assert_eq!(value.as_string().unwrap().as_str(), "safe content");
        // as_safe_string should work
        assert_eq!(value.as_safe_string().unwrap().as_str(), "safe content");
    }

    #[test]
    fn test_normal_string_not_safe() {
        let normal = VString::new("normal");
        let value: Value = normal.into();

        assert!(value.is_string());
        assert!(!value.is_safe_string());
        assert!(value.as_string().is_some());
        assert!(value.as_safe_string().is_none());
    }

    #[test]
    fn test_safe_string_equality() {
        let a = VSafeString::new("hello");
        let b = VSafeString::new("hello");
        let c = VSafeString::new("world");

        assert_eq!(a, b);
        assert_ne!(a, c);
        assert_eq!(a, "hello");

        // Equality with VString
        let vstring = VString::new("hello");
        assert_eq!(a, vstring);
        assert_eq!(vstring, a);
    }

    #[test]
    fn test_safe_string_into_string() {
        let safe = VSafeString::new("test");
        let vstring = safe.into_string();
        assert_eq!(vstring.as_str(), "test");
        assert!(vstring.is_safe()); // Flag should be preserved
    }

    #[test]
    fn test_safe_flag_constant() {
        // Verify the safe flag uses the high bit
        assert_eq!(SAFE_FLAG, 1usize << (usize::BITS - 1));
        // On 64-bit: 0x8000_0000_0000_0000
        // On 32-bit: 0x8000_0000
    }

    #[test]
    fn test_safe_string_long() {
        // Test with a string that would definitely be heap-allocated anyway
        let long = "a".repeat(1000);
        let safe = VSafeString::new(&long);
        assert_eq!(safe.len(), 1000);
        assert_eq!(safe.as_str(), long);

        let value: Value = safe.into();
        assert!(value.is_safe_string());
        assert_eq!(value.as_string().unwrap().len(), 1000);
    }
}

#[cfg(all(test, feature = "bolero-inline-tests"))]
mod bolero_props {
    use super::*;
    use crate::ValueType;
    use crate::array::VArray;
    use alloc::string::String;
    use alloc::vec::Vec;
    use bolero::check;

    #[test]
    fn bolero_inline_string_round_trip() {
        check!().with_type::<Vec<u8>>().for_each(|bytes: &Vec<u8>| {
            if bytes.len() > VString::INLINE_LEN_MAX + 8 {
                // Keep the generator focused on short payloads to hit inline cases hard.
                return;
            }

            if let Ok(s) = String::from_utf8(bytes.clone()) {
                let value = Value::from(s.as_str());
                let roundtrip = value.as_string().expect("expected string value");
                assert_eq!(roundtrip.as_str(), s);

                if VString::can_inline(s.len()) {
                    assert!(value.is_inline_string(), "expected inline tag for {s:?}");
                } else {
                    assert!(!value.is_inline_string(), "unexpected inline tag for {s:?}");
                }
            }
        });
    }

    #[test]
    fn bolero_string_mutation_sequences() {
        check!().with_type::<Vec<u8>>().for_each(|bytes: &Vec<u8>| {
            let mut value = Value::from("");
            let mut expected = String::new();

            for chunk in bytes.chunks(3).take(24) {
                let selector = chunk.first().copied().unwrap_or(0) % 3;
                match selector {
                    0 => {
                        let ch = (b'a' + chunk.get(1).copied().unwrap_or(0) % 26) as char;
                        expected.push(ch);
                    }
                    1 => {
                        if !expected.is_empty() {
                            let len = chunk
                                .get(1)
                                .copied()
                                .map(|n| (n as usize) % expected.len())
                                .unwrap_or(0);
                            expected.truncate(len);
                        }
                    }
                    _ => expected.clear(),
                }

                overwrite_value_string(&mut value, &expected);
                assert_eq!(value.as_string().unwrap().as_str(), expected);
                assert_eq!(
                    value.is_inline_string(),
                    expected.len() <= VString::INLINE_LEN_MAX,
                    "mutation sequence should keep inline status accurate"
                );
            }
        });
    }

    #[test]
    fn bolero_array_model_matches() {
        check!().with_type::<Vec<u8>>().for_each(|bytes: &Vec<u8>| {
            let mut arr = VArray::new();
            let mut model: Vec<String> = Vec::new();

            for chunk in bytes.chunks(4).take(20) {
                match chunk.first().copied().unwrap_or(0) % 4 {
                    0 => {
                        let content = inline_string_from_chunk(chunk, 1);
                        arr.push(Value::from(content.as_str()));
                        model.push(content);
                    }
                    1 => {
                        let idx = chunk.get(1).copied().unwrap_or(0) as usize;
                        if !model.is_empty() {
                            let idx = idx % model.len();
                            model.remove(idx);
                            let _ = arr.remove(idx);
                        }
                    }
                    2 => {
                        let content = inline_string_from_chunk(chunk, 2);
                        if model.is_empty() {
                            arr.insert(0, Value::from(content.as_str()));
                            model.insert(0, content);
                        } else {
                            let len = model.len();
                            let idx = (chunk.get(2).copied().unwrap_or(0) as usize) % (len + 1);
                            arr.insert(idx, Value::from(content.as_str()));
                            model.insert(idx, content);
                        }
                    }
                    _ => {
                        arr.clear();
                        model.clear();
                    }
                }

                assert_eq!(arr.len(), model.len());
                for (value, expected) in arr.iter().zip(model.iter()) {
                    assert_eq!(value.value_type(), ValueType::String);
                    assert_eq!(value.as_string().unwrap().as_str(), expected);
                    assert_eq!(
                        value.is_inline_string(),
                        expected.len() <= VString::INLINE_LEN_MAX
                    );
                }
            }
        });
    }

    fn overwrite_value_string(value: &mut Value, new_value: &str) {
        let slot = value.as_string_mut().expect("expected string value");
        *slot = VString::new(new_value);
    }

    fn inline_string_from_chunk(chunk: &[u8], seed_idx: usize) -> String {
        let len_hint = chunk.get(seed_idx).copied().unwrap_or(0) as usize;
        let len = len_hint % (VString::INLINE_LEN_MAX.saturating_sub(1).max(1));
        (0..len)
            .map(|i| {
                let byte = chunk.get(i % chunk.len()).copied().unwrap_or(b'a');
                (b'a' + (byte % 26)) as char
            })
            .collect()
    }
}