v8 147.1.0

Rust bindings to V8
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
//! SIMD-accelerated Unicode validation, transcoding, and base64.
//!
//! These bindings expose the [simdutf](https://github.com/simdutf/simdutf)
//! library that is already bundled with V8, avoiding C++ symbol clashes
//! that occur when linking a separate simdutf crate.
//!
//! Enable with the `simdutf` cargo feature.

// ---------------------------------------------------------------------------
// FFI declarations
// ---------------------------------------------------------------------------

#[repr(C)]
struct FfiResult {
  error: i32,
  count: usize,
}

unsafe extern "C" {
  // Validation
  fn simdutf__validate_utf8(buf: *const u8, len: usize) -> bool;
  fn simdutf__validate_utf8_with_errors(
    buf: *const u8,
    len: usize,
  ) -> FfiResult;
  fn simdutf__validate_ascii(buf: *const u8, len: usize) -> bool;
  fn simdutf__validate_ascii_with_errors(
    buf: *const u8,
    len: usize,
  ) -> FfiResult;
  fn simdutf__validate_utf16le(buf: *const u16, len: usize) -> bool;
  fn simdutf__validate_utf16le_with_errors(
    buf: *const u16,
    len: usize,
  ) -> FfiResult;
  fn simdutf__validate_utf16be(buf: *const u16, len: usize) -> bool;
  fn simdutf__validate_utf16be_with_errors(
    buf: *const u16,
    len: usize,
  ) -> FfiResult;
  fn simdutf__validate_utf32(buf: *const u32, len: usize) -> bool;
  fn simdutf__validate_utf32_with_errors(
    buf: *const u32,
    len: usize,
  ) -> FfiResult;

  // Conversion: UTF-8 <-> UTF-16LE
  fn simdutf__convert_utf8_to_utf16le(
    input: *const u8,
    length: usize,
    output: *mut u16,
  ) -> usize;
  fn simdutf__convert_utf8_to_utf16le_with_errors(
    input: *const u8,
    length: usize,
    output: *mut u16,
  ) -> FfiResult;
  fn simdutf__convert_valid_utf8_to_utf16le(
    input: *const u8,
    length: usize,
    output: *mut u16,
  ) -> usize;
  fn simdutf__convert_utf16le_to_utf8(
    input: *const u16,
    length: usize,
    output: *mut u8,
  ) -> usize;
  fn simdutf__convert_utf16le_to_utf8_with_errors(
    input: *const u16,
    length: usize,
    output: *mut u8,
  ) -> FfiResult;
  fn simdutf__convert_valid_utf16le_to_utf8(
    input: *const u16,
    length: usize,
    output: *mut u8,
  ) -> usize;

  // Conversion: UTF-8 <-> UTF-16BE
  fn simdutf__convert_utf8_to_utf16be(
    input: *const u8,
    length: usize,
    output: *mut u16,
  ) -> usize;
  fn simdutf__convert_utf16be_to_utf8(
    input: *const u16,
    length: usize,
    output: *mut u8,
  ) -> usize;

  // Conversion: UTF-8 <-> Latin-1
  fn simdutf__convert_utf8_to_latin1(
    input: *const u8,
    length: usize,
    output: *mut u8,
  ) -> usize;
  fn simdutf__convert_utf8_to_latin1_with_errors(
    input: *const u8,
    length: usize,
    output: *mut u8,
  ) -> FfiResult;
  fn simdutf__convert_valid_utf8_to_latin1(
    input: *const u8,
    length: usize,
    output: *mut u8,
  ) -> usize;
  fn simdutf__convert_latin1_to_utf8(
    input: *const u8,
    length: usize,
    output: *mut u8,
  ) -> usize;

  // Conversion: Latin-1 <-> UTF-16LE
  fn simdutf__convert_latin1_to_utf16le(
    input: *const u8,
    length: usize,
    output: *mut u16,
  ) -> usize;
  fn simdutf__convert_utf16le_to_latin1(
    input: *const u16,
    length: usize,
    output: *mut u8,
  ) -> usize;

  // Conversion: UTF-8 <-> UTF-32
  fn simdutf__convert_utf8_to_utf32(
    input: *const u8,
    length: usize,
    output: *mut u32,
  ) -> usize;
  fn simdutf__convert_utf32_to_utf8(
    input: *const u32,
    length: usize,
    output: *mut u8,
  ) -> usize;

  // Length calculation
  fn simdutf__utf8_length_from_utf16le(
    input: *const u16,
    length: usize,
  ) -> usize;
  fn simdutf__utf8_length_from_utf16be(
    input: *const u16,
    length: usize,
  ) -> usize;
  fn simdutf__utf16_length_from_utf8(input: *const u8, length: usize) -> usize;
  fn simdutf__utf8_length_from_latin1(input: *const u8, length: usize)
  -> usize;
  fn simdutf__latin1_length_from_utf8(input: *const u8, length: usize)
  -> usize;
  fn simdutf__utf32_length_from_utf8(input: *const u8, length: usize) -> usize;
  fn simdutf__utf8_length_from_utf32(input: *const u32, length: usize)
  -> usize;
  fn simdutf__utf16_length_from_utf32(
    input: *const u32,
    length: usize,
  ) -> usize;
  fn simdutf__utf32_length_from_utf16le(
    input: *const u16,
    length: usize,
  ) -> usize;

  // Counting
  fn simdutf__count_utf8(input: *const u8, length: usize) -> usize;
  fn simdutf__count_utf16le(input: *const u16, length: usize) -> usize;
  fn simdutf__count_utf16be(input: *const u16, length: usize) -> usize;

  // Encoding detection
  fn simdutf__detect_encodings(input: *const u8, length: usize) -> i32;

  // Base64
  fn simdutf__maximal_binary_length_from_base64(
    input: *const u8,
    length: usize,
  ) -> usize;
  fn simdutf__base64_to_binary(
    input: *const u8,
    length: usize,
    output: *mut u8,
    options: u64,
    last_chunk_options: u64,
  ) -> FfiResult;
  fn simdutf__base64_length_from_binary(length: usize, options: u64) -> usize;
  fn simdutf__binary_to_base64(
    input: *const u8,
    length: usize,
    output: *mut u8,
    options: u64,
  ) -> usize;
}

// ---------------------------------------------------------------------------
// Public types
// ---------------------------------------------------------------------------

/// Error codes returned by simdutf operations.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(i32)]
pub enum ErrorCode {
  Success = 0,
  HeaderBits = 1,
  TooShort = 2,
  TooLong = 3,
  Overlong = 4,
  TooLarge = 5,
  Surrogate = 6,
  InvalidBase64Character = 7,
  Base64InputRemainder = 8,
  Base64ExtraBits = 9,
  OutputBufferTooSmall = 10,
  Other = 11,
}

impl ErrorCode {
  fn from_i32(v: i32) -> Self {
    match v {
      0 => Self::Success,
      1 => Self::HeaderBits,
      2 => Self::TooShort,
      3 => Self::TooLong,
      4 => Self::Overlong,
      5 => Self::TooLarge,
      6 => Self::Surrogate,
      7 => Self::InvalidBase64Character,
      8 => Self::Base64InputRemainder,
      9 => Self::Base64ExtraBits,
      10 => Self::OutputBufferTooSmall,
      _ => Self::Other,
    }
  }
}

/// Result of a simdutf operation.
///
/// On success, `count` is the number of code units written/validated.
/// On error, `count` is the position of the error in the input.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SimdUtfResult {
  pub error: ErrorCode,
  pub count: usize,
}

impl SimdUtfResult {
  fn from_ffi(r: FfiResult) -> Self {
    Self {
      error: ErrorCode::from_i32(r.error),
      count: r.count,
    }
  }

  /// Returns `true` if the operation succeeded.
  #[inline]
  pub fn is_ok(&self) -> bool {
    self.error == ErrorCode::Success
  }
}

/// Encoding types detected by [`detect_encodings`].
///
/// The returned value is a bitmask — multiple encodings may be possible.
pub mod encoding {
  pub const UTF8: i32 = 1;
  pub const UTF16_LE: i32 = 2;
  pub const UTF16_BE: i32 = 4;
  pub const UTF32_LE: i32 = 8;
  pub const UTF32_BE: i32 = 16;
  pub const LATIN1: i32 = 32;
}

/// Base64 encoding/decoding options.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u64)]
pub enum Base64Options {
  /// Standard base64 with padding.
  Default = 0,
  /// URL-safe base64 without padding.
  Url = 1,
  /// Standard base64 without padding.
  DefaultNoPadding = 2,
  /// URL-safe base64 with padding.
  UrlWithPadding = 3,
}

/// Last chunk handling for base64 decoding.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u64)]
pub enum LastChunkHandling {
  /// Forgiving: decode partial final chunk.
  Loose = 0,
  /// Error on partial/unpadded last chunk.
  Strict = 1,
  /// Ignore partial last chunk (no error).
  StopBeforePartial = 2,
  /// Only decode full 4-character blocks.
  OnlyFullChunks = 3,
}

// ---------------------------------------------------------------------------
// Validation
// ---------------------------------------------------------------------------

/// Validates that the input is valid UTF-8.
#[inline]
pub fn validate_utf8(input: &[u8]) -> bool {
  unsafe { simdutf__validate_utf8(input.as_ptr(), input.len()) }
}

/// Validates UTF-8 and returns error position on failure.
#[inline]
pub fn validate_utf8_with_errors(input: &[u8]) -> SimdUtfResult {
  SimdUtfResult::from_ffi(unsafe {
    simdutf__validate_utf8_with_errors(input.as_ptr(), input.len())
  })
}

/// Validates that the input is valid ASCII.
#[inline]
pub fn validate_ascii(input: &[u8]) -> bool {
  unsafe { simdutf__validate_ascii(input.as_ptr(), input.len()) }
}

/// Validates ASCII and returns error position on failure.
#[inline]
pub fn validate_ascii_with_errors(input: &[u8]) -> SimdUtfResult {
  SimdUtfResult::from_ffi(unsafe {
    simdutf__validate_ascii_with_errors(input.as_ptr(), input.len())
  })
}

/// Validates that the input is valid UTF-16LE.
#[inline]
pub fn validate_utf16le(input: &[u16]) -> bool {
  unsafe { simdutf__validate_utf16le(input.as_ptr(), input.len()) }
}

/// Validates UTF-16LE and returns error position on failure.
#[inline]
pub fn validate_utf16le_with_errors(input: &[u16]) -> SimdUtfResult {
  SimdUtfResult::from_ffi(unsafe {
    simdutf__validate_utf16le_with_errors(input.as_ptr(), input.len())
  })
}

/// Validates that the input is valid UTF-16BE.
#[inline]
pub fn validate_utf16be(input: &[u16]) -> bool {
  unsafe { simdutf__validate_utf16be(input.as_ptr(), input.len()) }
}

/// Validates UTF-16BE and returns error position on failure.
#[inline]
pub fn validate_utf16be_with_errors(input: &[u16]) -> SimdUtfResult {
  SimdUtfResult::from_ffi(unsafe {
    simdutf__validate_utf16be_with_errors(input.as_ptr(), input.len())
  })
}

/// Validates that the input is valid UTF-32 (as native-endian `u32`).
#[inline]
pub fn validate_utf32(input: &[u32]) -> bool {
  unsafe { simdutf__validate_utf32(input.as_ptr(), input.len()) }
}

/// Validates UTF-32 and returns error position on failure.
#[inline]
pub fn validate_utf32_with_errors(input: &[u32]) -> SimdUtfResult {
  SimdUtfResult::from_ffi(unsafe {
    simdutf__validate_utf32_with_errors(input.as_ptr(), input.len())
  })
}

// ---------------------------------------------------------------------------
// Conversion: UTF-8 <-> UTF-16LE
// ---------------------------------------------------------------------------

/// Converts UTF-8 to UTF-16LE. Returns 0 if the input is not valid UTF-8.
///
/// # Safety
///
/// `output` must have at least `input.len()` elements of capacity.
/// Use [`utf16_length_from_utf8`] for an exact count.
#[inline]
pub unsafe fn convert_utf8_to_utf16le(
  input: &[u8],
  output: &mut [u16],
) -> usize {
  unsafe {
    simdutf__convert_utf8_to_utf16le(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

/// Converts UTF-8 to UTF-16LE with error reporting.
///
/// # Safety
///
/// `output` must have at least `input.len()` elements of capacity.
#[inline]
pub unsafe fn convert_utf8_to_utf16le_with_errors(
  input: &[u8],
  output: &mut [u16],
) -> SimdUtfResult {
  SimdUtfResult::from_ffi(unsafe {
    simdutf__convert_utf8_to_utf16le_with_errors(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  })
}

/// Converts valid UTF-8 to UTF-16LE. Input MUST be valid UTF-8.
///
/// # Safety
///
/// - The input must be valid UTF-8.
/// - `output` must have at least `input.len()` elements of capacity.
#[inline]
pub unsafe fn convert_valid_utf8_to_utf16le(
  input: &[u8],
  output: &mut [u16],
) -> usize {
  unsafe {
    simdutf__convert_valid_utf8_to_utf16le(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

/// Converts UTF-16LE to UTF-8. Returns 0 if the input is not valid UTF-16LE.
///
/// # Safety
///
/// `output` must have at least `input.len() * 3` bytes of capacity.
/// Use [`utf8_length_from_utf16le`] for an exact count.
#[inline]
pub unsafe fn convert_utf16le_to_utf8(
  input: &[u16],
  output: &mut [u8],
) -> usize {
  unsafe {
    simdutf__convert_utf16le_to_utf8(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

/// Converts UTF-16LE to UTF-8 with error reporting.
///
/// # Safety
///
/// `output` must have at least `input.len() * 3` bytes of capacity.
#[inline]
pub unsafe fn convert_utf16le_to_utf8_with_errors(
  input: &[u16],
  output: &mut [u8],
) -> SimdUtfResult {
  SimdUtfResult::from_ffi(unsafe {
    simdutf__convert_utf16le_to_utf8_with_errors(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  })
}

/// Converts valid UTF-16LE to UTF-8. Input MUST be valid UTF-16LE.
///
/// # Safety
///
/// - The input must be valid UTF-16LE.
/// - `output` must have at least `input.len() * 3` bytes of capacity.
#[inline]
pub unsafe fn convert_valid_utf16le_to_utf8(
  input: &[u16],
  output: &mut [u8],
) -> usize {
  unsafe {
    simdutf__convert_valid_utf16le_to_utf8(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

// ---------------------------------------------------------------------------
// Conversion: UTF-8 <-> UTF-16BE
// ---------------------------------------------------------------------------

/// Converts UTF-8 to UTF-16BE. Returns 0 on invalid input.
///
/// # Safety
///
/// `output` must have at least `input.len()` elements of capacity.
#[inline]
pub unsafe fn convert_utf8_to_utf16be(
  input: &[u8],
  output: &mut [u16],
) -> usize {
  unsafe {
    simdutf__convert_utf8_to_utf16be(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

/// Converts UTF-16BE to UTF-8. Returns 0 on invalid input.
///
/// # Safety
///
/// `output` must have at least `input.len() * 3` bytes of capacity.
#[inline]
pub unsafe fn convert_utf16be_to_utf8(
  input: &[u16],
  output: &mut [u8],
) -> usize {
  unsafe {
    simdutf__convert_utf16be_to_utf8(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

// ---------------------------------------------------------------------------
// Conversion: UTF-8 <-> Latin-1
// ---------------------------------------------------------------------------

/// Converts UTF-8 to Latin-1. Returns 0 on invalid input or if
/// characters are outside the Latin-1 range.
///
/// # Safety
///
/// `output` must have at least `input.len()` bytes of capacity.
/// Use [`latin1_length_from_utf8`] for an exact count.
#[inline]
pub unsafe fn convert_utf8_to_latin1(input: &[u8], output: &mut [u8]) -> usize {
  unsafe {
    simdutf__convert_utf8_to_latin1(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

/// Converts UTF-8 to Latin-1 with error reporting.
///
/// # Safety
///
/// `output` must have at least `input.len()` bytes of capacity.
#[inline]
pub unsafe fn convert_utf8_to_latin1_with_errors(
  input: &[u8],
  output: &mut [u8],
) -> SimdUtfResult {
  SimdUtfResult::from_ffi(unsafe {
    simdutf__convert_utf8_to_latin1_with_errors(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  })
}

/// Converts valid UTF-8 to Latin-1. Input MUST be valid UTF-8 containing
/// only codepoints in the Latin-1 range (U+0000..U+00FF).
///
/// # Safety
///
/// - The input must be valid UTF-8 with only Latin-1 codepoints.
/// - `output` must have at least `input.len()` bytes of capacity.
#[inline]
pub unsafe fn convert_valid_utf8_to_latin1(
  input: &[u8],
  output: &mut [u8],
) -> usize {
  unsafe {
    simdutf__convert_valid_utf8_to_latin1(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

/// Converts Latin-1 to UTF-8.
///
/// # Safety
///
/// `output` must have at least `input.len() * 2` bytes of capacity.
/// Use [`utf8_length_from_latin1`] for an exact count.
#[inline]
pub unsafe fn convert_latin1_to_utf8(input: &[u8], output: &mut [u8]) -> usize {
  unsafe {
    simdutf__convert_latin1_to_utf8(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

// ---------------------------------------------------------------------------
// Conversion: Latin-1 <-> UTF-16LE
// ---------------------------------------------------------------------------

/// Converts Latin-1 to UTF-16LE.
///
/// # Safety
///
/// `output` must have at least `input.len()` elements of capacity.
#[inline]
pub unsafe fn convert_latin1_to_utf16le(
  input: &[u8],
  output: &mut [u16],
) -> usize {
  unsafe {
    simdutf__convert_latin1_to_utf16le(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

/// Converts UTF-16LE to Latin-1. The input must only contain codepoints
/// in the Latin-1 range.
///
/// # Safety
///
/// `output` must have at least `input.len()` bytes of capacity.
#[inline]
pub unsafe fn convert_utf16le_to_latin1(
  input: &[u16],
  output: &mut [u8],
) -> usize {
  unsafe {
    simdutf__convert_utf16le_to_latin1(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

// ---------------------------------------------------------------------------
// Conversion: UTF-8 <-> UTF-32
// ---------------------------------------------------------------------------

/// Converts UTF-8 to UTF-32. Returns 0 on invalid input.
///
/// # Safety
///
/// `output` must have at least `input.len()` elements of capacity.
#[inline]
pub unsafe fn convert_utf8_to_utf32(input: &[u8], output: &mut [u32]) -> usize {
  unsafe {
    simdutf__convert_utf8_to_utf32(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

/// Converts UTF-32 to UTF-8. Returns 0 on invalid input.
///
/// # Safety
///
/// `output` must have at least `input.len() * 4` bytes of capacity.
#[inline]
pub unsafe fn convert_utf32_to_utf8(input: &[u32], output: &mut [u8]) -> usize {
  unsafe {
    simdutf__convert_utf32_to_utf8(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
    )
  }
}

// ---------------------------------------------------------------------------
// Length calculation
// ---------------------------------------------------------------------------

/// Returns the number of UTF-8 bytes needed to encode the given UTF-16LE
/// input.
#[inline]
pub fn utf8_length_from_utf16le(input: &[u16]) -> usize {
  unsafe { simdutf__utf8_length_from_utf16le(input.as_ptr(), input.len()) }
}

/// Returns the number of UTF-8 bytes needed to encode the given UTF-16BE
/// input.
#[inline]
pub fn utf8_length_from_utf16be(input: &[u16]) -> usize {
  unsafe { simdutf__utf8_length_from_utf16be(input.as_ptr(), input.len()) }
}

/// Returns the number of UTF-16 code units needed to encode the given
/// UTF-8 input.
#[inline]
pub fn utf16_length_from_utf8(input: &[u8]) -> usize {
  unsafe { simdutf__utf16_length_from_utf8(input.as_ptr(), input.len()) }
}

/// Returns the number of UTF-8 bytes needed to encode the given Latin-1 data.
#[inline]
pub fn utf8_length_from_latin1(input: &[u8]) -> usize {
  unsafe { simdutf__utf8_length_from_latin1(input.as_ptr(), input.len()) }
}

/// Returns the number of Latin-1 bytes that the given UTF-8 input would
/// produce. The input must contain only codepoints in the Latin-1 range.
#[inline]
pub fn latin1_length_from_utf8(input: &[u8]) -> usize {
  unsafe { simdutf__latin1_length_from_utf8(input.as_ptr(), input.len()) }
}

/// Returns the number of UTF-32 code units needed for the given UTF-8
/// input.
#[inline]
pub fn utf32_length_from_utf8(input: &[u8]) -> usize {
  unsafe { simdutf__utf32_length_from_utf8(input.as_ptr(), input.len()) }
}

/// Returns the number of UTF-8 bytes needed for the given UTF-32 input.
#[inline]
pub fn utf8_length_from_utf32(input: &[u32]) -> usize {
  unsafe { simdutf__utf8_length_from_utf32(input.as_ptr(), input.len()) }
}

/// Returns the number of UTF-16 code units needed for the given UTF-32
/// input.
#[inline]
pub fn utf16_length_from_utf32(input: &[u32]) -> usize {
  unsafe { simdutf__utf16_length_from_utf32(input.as_ptr(), input.len()) }
}

/// Returns the number of UTF-32 code units needed for the given
/// UTF-16LE input.
#[inline]
pub fn utf32_length_from_utf16le(input: &[u16]) -> usize {
  unsafe { simdutf__utf32_length_from_utf16le(input.as_ptr(), input.len()) }
}

// ---------------------------------------------------------------------------
// Counting
// ---------------------------------------------------------------------------

/// Counts the number of Unicode codepoints in the UTF-8 input.
/// The input must be valid UTF-8.
#[inline]
pub fn count_utf8(input: &[u8]) -> usize {
  unsafe { simdutf__count_utf8(input.as_ptr(), input.len()) }
}

/// Counts the number of Unicode codepoints in the UTF-16LE input.
/// The input must be valid UTF-16LE.
#[inline]
pub fn count_utf16le(input: &[u16]) -> usize {
  unsafe { simdutf__count_utf16le(input.as_ptr(), input.len()) }
}

/// Counts the number of Unicode codepoints in the UTF-16BE input.
/// The input must be valid UTF-16BE.
#[inline]
pub fn count_utf16be(input: &[u16]) -> usize {
  unsafe { simdutf__count_utf16be(input.as_ptr(), input.len()) }
}

// ---------------------------------------------------------------------------
// Encoding detection
// ---------------------------------------------------------------------------

/// Detects which encodings the input could be.
///
/// Returns a bitmask of possible encodings. Use the constants in
/// [`encoding`] to test the result:
///
/// ```ignore
/// let mask = v8::simdutf::detect_encodings(data);
/// if mask & v8::simdutf::encoding::UTF8 != 0 {
///     // Could be UTF-8
/// }
/// ```
#[inline]
pub fn detect_encodings(input: &[u8]) -> i32 {
  unsafe { simdutf__detect_encodings(input.as_ptr(), input.len()) }
}

// ---------------------------------------------------------------------------
// Base64
// ---------------------------------------------------------------------------

/// Returns the maximum number of binary bytes that could result from
/// decoding the given base64 input.
#[inline]
pub fn maximal_binary_length_from_base64(input: &[u8]) -> usize {
  unsafe {
    simdutf__maximal_binary_length_from_base64(input.as_ptr(), input.len())
  }
}

/// Decodes base64 input to binary.
///
/// # Safety
///
/// `output` must have at least
/// [`maximal_binary_length_from_base64`]`(input)` bytes of capacity.
#[inline]
pub unsafe fn base64_to_binary(
  input: &[u8],
  output: &mut [u8],
  options: Base64Options,
  last_chunk: LastChunkHandling,
) -> SimdUtfResult {
  SimdUtfResult::from_ffi(unsafe {
    simdutf__base64_to_binary(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
      options as u64,
      last_chunk as u64,
    )
  })
}

/// Returns the number of base64 characters needed to encode the given
/// number of binary bytes.
#[inline]
pub fn base64_length_from_binary(
  length: usize,
  options: Base64Options,
) -> usize {
  unsafe { simdutf__base64_length_from_binary(length, options as u64) }
}

/// Encodes binary data to base64.
///
/// # Safety
///
/// `output` must have at least
/// [`base64_length_from_binary`]`(input.len(), options)` bytes of capacity.
#[inline]
pub unsafe fn binary_to_base64(
  input: &[u8],
  output: &mut [u8],
  options: Base64Options,
) -> usize {
  unsafe {
    simdutf__binary_to_base64(
      input.as_ptr(),
      input.len(),
      output.as_mut_ptr(),
      options as u64,
    )
  }
}