Skip to main content

qubit_codec/byte_order/
native_endian.rs

1// =============================================================================
2//    Copyright (c) 2026 Haixing Hu.
3//
4//    SPDX-License-Identifier: Apache-2.0
5//
6//    Licensed under the Apache License, Version 2.0.
7// =============================================================================
8
9use super::ByteOrder;
10use super::ByteOrderSpec;
11
12/// Type-level marker for native-endian byte order.
13///
14/// # Examples
15///
16/// ```
17/// use qubit_codec::{ByteOrder, ByteOrderSpec, NativeEndian};
18///
19/// let _: NativeEndian = Default::default();
20/// assert_eq!(NativeEndian::ORDER, ByteOrder::NativeEndian);
21/// ```
22#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
23pub struct NativeEndian;
24
25impl ByteOrderSpec for NativeEndian {
26    /// The native-endian byte order.
27    const ORDER: ByteOrder = ByteOrder::NativeEndian;
28}