thruput-xdrs 0.17.1

XDR Serialization Library
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
//! Writing Rust values as XDR data.
//!
//! This module provides the [`WriteXDR`] trait and implementations for
//! converting Rust values into [XDR][RFC-4506]-encoded data.
//!
//! [RFC-4506]: https://datatracker.ietf.org/doc/html/rfc4506

use crate::serialize::writer::*;
use crate::serialize::writer_unchecked::*;
use crate::valid_u32::*;
use core::convert::Infallible;

/// Types that can be written as XDR data.
///
/// Types implementing this trait can be serialized into XDR format
/// using any writer that implements [`Writer`].
///
/// The trait has two required methods: [`write_xdr`](Self::write_xdr) (the
/// checked, fallible path) and [`write_xdr_unchecked`](Self::write_xdr_unchecked)
/// (an `unsafe`, infallible path with no runtime checks). `#[derive(WriteXDR)]`
/// implements both automatically; manual implementors must provide both — the
/// unchecked method must uphold the buffer-size and value-bound contract
/// documented on [`write_xdr_unchecked`](Self::write_xdr_unchecked).
/// Manual implementors should also add `impl EncodesAs<Self> for T {}`
/// (which the derive emits), so the type can be passed where an
/// [`EncodesAs`](crate::EncodesAs) bound expects it.
///
/// # Example
///
/// ```rust
/// use xdrs::cxs;
/// use core::mem::MaybeUninit;
///
/// let value: u32 = 42;
/// let mut buf = [MaybeUninit::uninit(); 16];
/// let written = cxs::encode_into(&value, &mut buf)?;
/// # Ok::<(), xdrs::WriteError>(())
/// ```
pub trait WriteXDR {
    /// Writes this value as XDR data to the writer.
    ///
    /// This method should write the appropriate XDR-encoded representation
    /// of `self` to the writer.
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()>;

    /// Writes this value as XDR data to the writer, without runtime checks.
    ///
    /// This is the infallible, unsafe counterpart to
    /// [`write_xdr`](Self::write_xdr), for use with
    /// [`WriterUnchecked`] writers on code-size-sensitive targets.
    ///
    /// # Safety
    ///
    /// - The writer's underlying buffer must have enough space remaining
    ///   for the encoded form of `self`.
    /// - `self` must respect all declared XDR bounds (e.g. a
    ///   `VecM<T, MAX>` must not be longer than `MAX`), since a violation
    ///   would make the encoding exceed any precomputed size bound. This
    ///   includes the implicit `u32::MAX` upper limit on variable-length
    ///   arrays and strings: the checked path returns
    ///   [`WriteError::InvalidArrayLength`] for lengths exceeding
    ///   `u32::MAX`; the unchecked path only `debug_assert!`s this
    ///   condition.
    ///
    /// Violations are `debug_assert!`ed; in release builds they are
    /// undefined behavior.
    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W);
}

/// Writes an XDR value to the writer.
///
/// This is a convenience function that calls [`WriteXDR::write_xdr`] on the value.
///
/// # Example
///
/// ```rust
/// use xdrs::cxs;
/// use core::mem::MaybeUninit;
///
/// let value: u32 = 42;
/// let mut buf = [MaybeUninit::uninit(); 16];
/// let written = cxs::encode_into(&value, &mut buf)?;
/// # Ok::<(), xdrs::WriteError>(())
/// ```
#[inline]
pub fn write_xdr<T, F, W>(this: &T, w: &mut W) -> WriteResult<()>
where
    T: WriteXDR,
    W: Writer<F>,
{
    this.write_xdr(w)
}

/// Writes an XDR value to the writer, without runtime checks.
///
/// This is a convenience function that calls
/// [`WriteXDR::write_xdr_unchecked`] on the value.
///
/// # Safety
///
/// Same contract as [`WriteXDR::write_xdr_unchecked`]: the writer must have
/// space for the encoded form of `this`, and `this` must respect all
/// declared XDR bounds.
#[inline]
pub unsafe fn write_xdr_unchecked<T, F, W>(this: &T, w: &mut W)
where
    T: WriteXDR,
    W: WriterUnchecked<F>,
{
    // SAFETY: forwarded caller contract.
    unsafe { this.write_xdr_unchecked(w) }
}

macro_rules! write_xdr_int_impls {
    { $( $write_method:ident for $int_ty:ty ),* $(,)? } => { $(

        impl WriteXDR for $int_ty {
            #[inline]
            fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
                w.$write_method(*self)
            }

            #[inline]
            unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
                // SAFETY: forwarded caller contract.
                unsafe { w.$write_method(*self) }
            }
        }

    )* };
}

write_xdr_int_impls! {
    write_i64 for i64,
    write_i32 for i32,
    write_i16 for i16,

    write_u64 for u64,
    write_u32 for u32,
    write_u16 for u16,

    write_bool for bool,
    write_f32 for f32,
    write_f64 for f64,
}

impl WriteXDR for [u8] {
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        w.write_opaque_variable(self)
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        // SAFETY: forwarded caller contract.
        unsafe { w.write_opaque_variable(self) }
    }
}

impl<const N: usize> WriteXDR for [u8; N] {
    #[inline]
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        let () = ValidU32::<N>::OK;

        w.write_opaque_fixed(self)
    }

    #[inline]
    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        let () = ValidU32::<N>::OK;

        // SAFETY: forwarded caller contract.
        unsafe { w.write_opaque_fixed(self) }
    }
}

impl<T: WriteXDR, const N: usize> WriteXDR for [T; N] {
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        let () = ValidU32::<N>::OK;

        for elt in self {
            elt.write_xdr(w)?;
        }
        Ok(())
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        let () = ValidU32::<N>::OK;

        for elt in self {
            // SAFETY: the caller guarantees space for every element.
            unsafe { elt.write_xdr_unchecked(w) };
        }
    }
}

impl<T: WriteXDR> WriteXDR for [T] {
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        if self.len() > u32::MAX as usize {
            return Err(WriteError::InvalidArrayLength);
        }
        let len = self.len() as u32;
        w.write_u32(len)?;

        for elt in self {
            elt.write_xdr(w)?;
        }
        Ok(())
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        debug_assert!(self.len() <= u32::MAX as usize);
        // SAFETY: the caller guarantees space for the length prefix and
        // every element.
        unsafe {
            w.write_u32(self.len() as u32);
            for elt in self {
                elt.write_xdr_unchecked(w);
            }
        }
    }
}

// `?Sized` so a `&'a T` field under a `T: WriteXDR + ?Sized` bound can derive.
// This subsumes `&[u8]`, `&[T]` and `&str` through their pointee impls above —
// a concrete impl for any of them would overlap this one and fail coherence.
impl<T: WriteXDR + ?Sized> WriteXDR for &T {
    #[inline]
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        (*self).write_xdr(w)
    }

    #[inline]
    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        // SAFETY: forwarded caller contract.
        unsafe { (*self).write_xdr_unchecked(w) }
    }
}

impl<T: WriteXDR + ?Sized> WriteXDR for &mut T {
    #[inline]
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        (**self).write_xdr(w)
    }

    #[inline]
    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        // SAFETY: forwarded caller contract.
        unsafe { (**self).write_xdr_unchecked(w) }
    }
}

impl WriteXDR for str {
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        w.write_opaque_variable(self.as_bytes())
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        // SAFETY: forwarded caller contract.
        unsafe { w.write_opaque_variable(self.as_bytes()) }
    }
}

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
impl WriteXDR for alloc::string::String {
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        self.as_str().write_xdr(w)
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        // SAFETY: forwarded caller contract.
        unsafe { self.as_str().write_xdr_unchecked(w) }
    }
}

impl WriteXDR for () {
    fn write_xdr<F, W: Writer<F>>(&self, _w: &mut W) -> WriteResult<()> {
        Ok(())
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, _w: &mut W) {}
}

impl WriteXDR for Infallible {
    fn write_xdr<F, W: Writer<F>>(&self, _w: &mut W) -> WriteResult<()> {
        unreachable!()
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, _w: &mut W) {
        match *self {}
    }
}

macro_rules! write_tuple {
    { $( ($v:ident, $t:ident) ),+ } => {

        impl<$($t),+> WriteXDR for ($($t),+)
        where
            $( $t: WriteXDR, )+
        {
            fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
                let ( $($v),+ ) = self;
                $( write_xdr($v, w)?; )+
                Ok(())
            }

            unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
                let ( $($v),+ ) = self;
                // SAFETY: the caller guarantees space for the whole tuple.
                unsafe { $( write_xdr_unchecked($v, w); )+ }
            }
        }

    };
}

write_tuple! { (t0, T0), (t1, T1) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6), (t7, T7) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6), (t7, T7), (t8, T8) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6), (t7, T7), (t8, T8), (t9, T9) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6), (t7, T7), (t8, T8), (t9, T9), (t10, T10) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6), (t7, T7), (t8, T8), (t9, T9), (t10, T10), (t11, T11) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6), (t7, T7), (t8, T8), (t9, T9), (t10, T10), (t11, T11), (t12, T12) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6), (t7, T7), (t8, T8), (t9, T9), (t10, T10), (t11, T11), (t12, T12), (t13, T13) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6), (t7, T7), (t8, T8), (t9, T9), (t10, T10), (t11, T11), (t12, T12), (t13, T13), (t14, T14) }
write_tuple! { (t0, T0), (t1, T1), (t2, T2), (t3, T3), (t4, T4), (t5, T5), (t6, T6), (t7, T7), (t8, T8), (t9, T9), (t10, T10), (t11, T11), (t12, T12), (t13, T13), (t14, T14), (t15, T15) }

// impl for single-element tuples
impl<T: WriteXDR> WriteXDR for (T,) {
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        let (t,) = self;
        t.write_xdr(w)
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        let (t,) = self;
        // SAFETY: forwarded caller contract.
        unsafe { t.write_xdr_unchecked(w) }
    }
}

impl<T: WriteXDR> WriteXDR for Option<T> {
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        if let Some(val) = self {
            w.write_i32(1)?;
            val.write_xdr(w)
        } else {
            w.write_i32(0)
        }
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        // SAFETY: the caller guarantees space for the tag and the payload.
        unsafe {
            if let Some(val) = self {
                w.write_i32(1);
                val.write_xdr_unchecked(w);
            } else {
                w.write_i32(0);
            }
        }
    }
}

const _: () = {
    use super::*;
    use crate::serialize::writer::Writer;
    use crate::serialize::writer_unchecked::WriterUnchecked;
    use xdr_common::*;

    impl<const MAX: u32> WriteXDR for BytesM<MAX> {
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            if self.0.len() > MAX as usize {
                return Err(WriteError::InvalidArrayLength);
            }
            self.0.write_xdr(w)
        }

        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            debug_assert!(
                self.0.len() <= MAX as usize,
                "BytesM exceeds declared bound"
            );
            // SAFETY: the caller guarantees the value respects its declared
            // bound and that the writer has space for the encoded form.
            unsafe { self.0.write_xdr_unchecked(w) }
        }
    }

    // Make VecM<u8> work like BytesM;
    #[cfg(feature = "alloc")]
    impl<const MAX: u32> WriteXDR for VecM<u8, MAX> {
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            if self.0.len() > MAX as usize {
                return Err(WriteError::InvalidArrayLength);
            }
            self.0.write_xdr(w)
        }

        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            debug_assert!(self.0.len() <= MAX as usize, "VecM exceeds declared bound");
            // SAFETY: the caller guarantees the value respects its declared
            // bound and that the writer has space for the encoded form.
            unsafe { self.0.write_xdr_unchecked(w) }
        }
    }
    #[cfg(not(feature = "alloc"))]
    impl<const MAX: u32> WriteXDR for VecM<u8, MAX> {
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            if self.len() > MAX as usize {
                return Err(WriteError::InvalidArrayLength);
            }
            <Self as AsRef<[u8]>>::as_ref(self).write_xdr(w)
        }

        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            debug_assert!(self.len() <= MAX as usize, "VecM exceeds declared bound");
            // SAFETY: the caller guarantees the value respects its declared
            // bound and that the writer has space for the encoded form.
            unsafe { <Self as AsRef<[u8]>>::as_ref(self).write_xdr_unchecked(w) }
        }
    }

    impl<const MAX: u32> WriteXDR for StringM<MAX> {
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            if self.0.len() > MAX as usize {
                return Err(WriteError::InvalidArrayLength);
            }
            self.0.write_xdr(w)
        }

        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            debug_assert!(
                self.0.len() <= MAX as usize,
                "StringM exceeds declared bound"
            );
            // SAFETY: the caller guarantees the value respects its declared
            // bound and that the writer has space for the encoded form.
            unsafe { self.0.write_xdr_unchecked(w) }
        }
    }

    #[cfg(feature = "alloc")]
    impl<const MAX: u32, T> WriteXDR for VecM<T, MAX>
    where
        T: WriteXDR,
    {
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            if self.len() > MAX as usize {
                return Err(WriteError::InvalidArrayLength);
            }
            <Self as AsRef<[T]>>::as_ref(self).write_xdr(w)
        }

        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            debug_assert!(self.len() <= MAX as usize, "VecM exceeds declared bound");
            // SAFETY: the caller guarantees the value respects its declared
            // bound and that the writer has space for the encoded form.
            unsafe { <Self as AsRef<[T]>>::as_ref(self).write_xdr_unchecked(w) }
        }
    }

    #[cfg(not(feature = "alloc"))]
    impl<const MAX: u32, T> WriteXDR for VecM<T, MAX>
    where
        T: WriteXDR + 'static,
    {
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            if self.len() > MAX as usize {
                return Err(WriteError::InvalidArrayLength);
            }
            <Self as AsRef<[T]>>::as_ref(self).write_xdr(w)
        }

        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            debug_assert!(self.len() <= MAX as usize, "VecM exceeds declared bound");
            // SAFETY: the caller guarantees the value respects its declared
            // bound and that the writer has space for the encoded form.
            unsafe { <Self as AsRef<[T]>>::as_ref(self).write_xdr_unchecked(w) }
        }
    }

    // On the heap `Box` itself rather than the `xdr_common::Box` alias, whose
    // parameter is implicitly `Sized`: `?Sized` admits `Box<[T]>` and
    // `Box<str>`, as for `&T` and `Arc<T>`.
    #[cfg(feature = "alloc")]
    #[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
    impl<T: WriteXDR + ?Sized> WriteXDR for alloc::boxed::Box<T> {
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            (**self).write_xdr(w)
        }

        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            // SAFETY: forwarded caller contract.
            unsafe { (**self).write_xdr_unchecked(w) }
        }
    }
};

#[cfg(not(feature = "alloc"))]
impl<T: WriteXDR> WriteXDR for xdr_common::Box<T> {
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        (**self).write_xdr(w)
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        // SAFETY: forwarded caller contract.
        unsafe { (**self).write_xdr_unchecked(w) }
    }
}

impl<T, E> WriteXDR for Result<T, E>
where
    T: WriteXDR,
    E: WriteXDR,
{
    fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
        match self {
            Ok(x) => {
                w.write_i32(0)?;
                x.write_xdr(w)
            }
            Err(e) => {
                w.write_i32(1)?;
                e.write_xdr(w)
            }
        }
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
        // SAFETY: the caller guarantees space for the tag and the payload.
        unsafe {
            match self {
                Ok(x) => {
                    w.write_i32(0);
                    x.write_xdr_unchecked(w);
                }
                Err(e) => {
                    w.write_i32(1);
                    e.write_xdr_unchecked(w);
                }
            }
        }
    }
}

impl<T> WriteXDR for core::marker::PhantomData<T> {
    fn write_xdr<F, W: Writer<F>>(&self, _w: &mut W) -> WriteResult<()> {
        Ok(())
    }

    unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, _w: &mut W) {}
}

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
const _: () = {
    use crate::serialize::writer_unchecked::WriterUnchecked;
    use alloc::vec::Vec;

    impl WriteXDR for Vec<u8> {
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            w.write_opaque_variable(self.as_ref())
        }

        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            // SAFETY: forwarded caller contract.
            unsafe { w.write_opaque_variable(self.as_ref()) }
        }
    }

    impl<T> WriteXDR for Vec<T>
    where
        T: WriteXDR,
    {
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            let slice: &[T] = self.as_ref();
            slice.write_xdr(w)
        }

        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            let slice: &[T] = self.as_ref();
            // SAFETY: forwarded caller contract.
            unsafe { slice.write_xdr_unchecked(w) }
        }
    }

    // `alloc::sync` exists only on targets with pointer-sized atomics.
    #[cfg(target_has_atomic = "ptr")]
    impl<T: WriteXDR + ?Sized> WriteXDR for alloc::sync::Arc<T> {
        #[inline]
        fn write_xdr<F, W: Writer<F>>(&self, w: &mut W) -> WriteResult<()> {
            (**self).write_xdr(w)
        }

        #[inline]
        unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, w: &mut W) {
            // SAFETY: forwarded caller contract.
            unsafe { (**self).write_xdr_unchecked(w) }
        }
    }
};

#[cfg(test)]
mod tests {
    use super::*;
    use core::mem::MaybeUninit;

    #[test]
    fn tuple_unchecked_writes_txs() {
        let mut buf = [MaybeUninit::uninit(); 8];
        let mut w = crate::txs::unchecked_buf_writer::UncheckedBufWriter::new(&mut buf);
        // SAFETY: two u32s occupy exactly the 8-byte buffer.
        unsafe { (1u32, 2u32).write_xdr_unchecked(&mut w) };
        assert_eq!(w.written(), 8);
        // SAFETY: the first 8 bytes were just initialized.
        let bytes = unsafe { buf[..8].assume_init_ref() };
        assert_eq!(bytes, [0, 0, 0, 1, 0, 0, 0, 2]);
    }
}