// Copyright 2022 Nathaniel Bennett <me[at]nathanielbennett[dotcom]>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Internet Protocol (IP) network layers, including IPSec.
//!
//!

use core::cmp;
use core::fmt::Debug;
use core::iter::Iterator;

use pkts_macros::{Layer, LayerMut, LayerRef, StatelessLayer};

use crate::layers::traits::extras::*;
use crate::layers::traits::*;
use crate::{error::*, utils};

use super::sctp::{Sctp, SctpRef};
use super::tcp::{Tcp, TcpRef};
use super::udp::{Udp, UdpRef};
use super::{Raw, RawRef};

/// Internet Protocol, Version 4 (see RFC 760)
pub const IP_VERSION_IPV4: u8 = 4;
/// Internet Stream Protocol (ST or ST-II) (see RFC 1819)
pub const IP_VERSION_ST: u8 = 5;
/// Internet Protocol, Version 6 (see RFC 2460)
pub const IP_VERSION_IPV6: u8 = 6;
/// TP/IX The Next Internet (IPv7) (see RVC 1475)
pub const IP_VERSION_TPIX: u8 = 7;
/// P Internet Protocol (see RFC 1621)
pub const IP_VERSION_PIP: u8 = 8;
/// TCP and UDP over Bigger Addresses (TUBA) (see RFC 1347)
const IP_VERSION_TUBA: u8 = 9;

/// IPv6 Hop-by-Hop Option (see RFC 8200)
pub const DATA_PROTO_HOP_OPT: u8 = 0x00;
/// Internet Control Message Protocol (see RFC 792)
pub const DATA_PROTO_ICMP: u8 = 0x01;
/// Internet Group Management Protocol (see RFC 1112)
pub const DATA_PROTO_IGMP: u8 = 0x02;
/// Gateway-to-Gateway Protocol (see RFC 823)
pub const DATA_PROTO_GGP: u8 = 0x03;
/// IP in IP encapsulation (see [`Ipv4`], [`Ipv6`], RFC 2003)
pub const DATA_PROTO_IP_IN_IP: u8 = 0x04;
/// Internet Stream Protocol (see RFC 1190 and RFC 1819)
pub const DATA_PROTO_ST: u8 = 0x05;
/// Transmission Control Protocol (see [`Tcp`], RFC 793)
pub const DATA_PROTO_TCP: u8 = 0x06;
/// Core-Based Trees (see RFC 2189)
pub const DATA_PROTO_CBT: u8 = 0x07;
/// Exterior Gateway Protocol (see RFC 888)
pub const DATA_PROTO_EGP: u8 = 0x08;
/// Interior gateway Protocol
pub const DATA_PROTO_IGP: u8 = 0x09;
/// BBN RCC Monitoringdata[0] & 0x0F
pub const DATA_PROTO_BBN_RCC_MON: u8 = 0x0A;
/// Network Voide Protocol (see RFC 741)
pub const DATA_PROTO_NVP2: u8 = 0x0B;
/// Xerox PUP
pub const DATA_PROTO_PUP: u8 = 0x0C;
/// ARGUS
pub const DATA_PROTO_ARGUS: u8 = 0x0D;
/// EMCON
pub const DATA_PROTO_EMCON: u8 = 0x0E;
/// Cross-Net Debugger (see IEN 158)
pub const DATA_PROTO_XNET: u8 = 0x0F;
/// CHAOS
pub const DATA_PROTO_CHAOS: u8 = 0x10;
/// User Datagram Protocol (see [`Udp`], RFC 741)
pub const DATA_PROTO_UDP: u8 = 0x11;
/// Multiplexing (see IEN 90)
pub const DATA_PROTO_MUX: u8 = 0x12;
/// DCN Measurement Subsystems
pub const DATA_PROTO_DCN_MEAS: u8 = 0x13;
/// Host Monitoring Protocol (see RFC 869)
pub const DATA_PROTO_HMP: u8 = 0x14;
/// Packet Radio Measurement
pub const DATA_PROTO_PRM: u8 = 0x15;
/// XEROX NS IDP
pub const DATA_PROTO_XNS_IDP: u8 = 0x16;
/// Trunk-1
pub const DATA_PROTO_TRUNK1: u8 = 0x17;
/// Trunk-2
pub const DATA_PROTO_TRUNK2: u8 = 0x18;
/// Leaf-1
pub const DATA_PROTO_LEAF1: u8 = 0x19;
/// Leaf-2
pub const DATA_PROTO_LEAF2: u8 = 0x1A;
/// Reliable Data Protocol (see RFC 908)
pub const DATA_PROTO_RDP: u8 = 0x1B;
/// Internet Reliable Transaction Protocol (see RFC 938)
pub const DATA_PROTO_IRTP: u8 = 0x1C;
/// ISO Transport Protocol Class 4 (see RFC 905)
pub const DATA_PROTO_ISO_TP4: u8 = 0x1D;
/// Bulk Data Transfer Protocol (see RFC 998)
pub const DATA_PROTO_NET_BLT: u8 = 0x1E;
/// MFE Network Services Protocol
pub const DATA_PROTO_MFE_NSP: u8 = 0x1F;
/// MERIT Internodal Protocol
pub const DATA_PROTO_MERIT_INP: u8 = 0x20;
/// Datagram Congestion Control Protocol (see RFC 4340)
pub const DATA_PROTO_DCCP: u8 = 0x21;
/// Third Party Connect Protocol
pub const DATA_PROTO_TPCP: u8 = 0x22;
/// Inter-Domain Policy Routing Protocol (see RFC 1479)
pub const DATA_PROTO_IDPR: u8 = 0x23;
/// Xpress Transport Protocol
pub const DATA_PROTO_XTP: u8 = 0x24;
/// Datagram Delivery Protocol
pub const DATA_PROTO_DDP: u8 = 0x25;
/// IDPR Control Message Transport Protocol
pub const DATA_PROTO_IDPR_CMTP: u8 = 0x26;
/// TP++ Transport Protocol
pub const DATA_PROTO_TP_PLUS_PLUS: u8 = 0x27;
/// IL Transport Protocol
pub const DATA_PROTO_IL: u8 = 0x28;
/// IPv6 Encapsulation--6to4 and 6in4 (see RFC 2473)
pub const DATA_PROTO_IPV6: u8 = 0x29;
/// Source Demand Routing Protocol (see RFC 1940)
pub const DATA_PROTO_SDRP: u8 = 0x2A;
/// Routing Header for IPv6 (see RFC 8200)
pub const DATA_PROTO_IPV6_ROUTE: u8 = 0x2B;
/// Fragment Header for IPv6 (see RFC 8200)
pub const DATA_PROTO_IPV6_FRAG: u8 = 0x2C;
/// Inter-Domain Routing Protocol
pub const DATA_PROTO_IDRP: u8 = 0x2D;
/// Resource Reservation Protocol (see RFC 2205)
pub const DATA_PROTO_RSVP: u8 = 0x2E;
/// Generic Routing Encapsulation (see RFC 2784, RFC 2890)
pub const DATA_PROTO_GRE: u8 = 0x2F;
/// Dynamic Source Routing Protocol (see RFC 4728)
pub const DATA_PROTO_DSR: u8 = 0x30;
/// Burroughs Network Architecture
pub const DATA_PROTO_BNA: u8 = 0x31;
/// Encapsulating Security Payload (see RFC 4303)
pub const DATA_PROTO_ESP: u8 = 0x32;
/// Authentication Header (see RFC 4302)
pub const DATA_PROTO_AH: u8 = 0x33;
/// Integrated Net Layer Security Protocol
pub const DATA_PROTO_INLSP: u8 = 0x34;
/// SwIPe (see RFC 5237)
pub const DATA_PROTO_SWIPE: u8 = 0x35;
/// NBMA Address Resolution Protocol (see RFC 1735)
pub const DATA_PROTO_NARP: u8 = 0x36;
/// IP Mobility (Min Encap) (see RFC 2004)
pub const DATA_PROTO_MOBILE: u8 = 0x37;
/// Transport Layer Security Protocol (using Kryptonet key management)
pub const DATA_PROTO_TLSP: u8 = 0x38;
/// Simple Key-Management for Internet Protocol (see RFC 2356)
pub const DATA_PROTO_SKIP: u8 = 0x39;
/// ICMP for IPv6 (see RFC 4443, RFC 4884)
pub const DATA_PROTO_IPV6_ICMP: u8 = 0x3A;
/// No Next Header for IPv6 (see RFC 8200)
pub const DATA_PROTO_IPV6_NO_NXT: u8 = 0x3B;
/// Destination Options for IPv6 (see RFC 8200)
pub const DATA_PROTO_IPV6_OPTS: u8 = 0x3C;
/// Any host internal protocol
pub const DATA_PROTO_ANY_HOST_INTERNAL: u8 = 0x3D;
/// CFTP
pub const DATA_PROTO_CFTP: u8 = 0x3E;
/// Any local network
pub const DATA_PROTO_ANY_LOCAL_NETWORK: u8 = 0x3F;
/// SATNET and Backroom EXPAK
pub const DATA_PROTO_SAT_EXPAK: u8 = 0x40;
/// Kryptolan
pub const DATA_PROTO_KRYPTO_LAN: u8 = 0x41;
/// MIT Remote Virtual Disk Protocol
pub const DATA_PROTO_RVD: u8 = 0x42;
/// Internet Pluribus Packet Core
pub const DATA_PROTO_IPPC: u8 = 0x43;
/// Any distributed file system
pub const DATA_PROTO_ANY_DISTRIB_FS: u8 = 0x44;
/// SATNET Monitoring
pub const DATA_PROTO_SAT_MON: u8 = 0x45;
/// VISA Protocol
pub const DATA_PROTO_VISA: u8 = 0x46;
/// Internet Packet Core Utility
pub const DATA_PROTO_IPCU: u8 = 0x47;
/// Computer Protocol Network Executive
pub const DATA_PROTO_CPNX: u8 = 0x48;
/// Computer Protocol Heart Beat
pub const DATA_PROTO_CPHB: u8 = 0x49;
/// Wang Span Network
pub const DATA_PROTO_WSN: u8 = 0x4A;
/// Packet Video Protocol
pub const DATA_PROTO_PVP: u8 = 0x4B;
/// Backroom SATNET Monitoring
pub const DATA_PROTO_BR_SAT_MON: u8 = 0x4C;
/// SUN ND PROTOCOL-Temporary
pub const DATA_PROTO_SUN_ND: u8 = 0x4D;
/// WIDEBAND Monitoring
pub const DATA_PROTO_WB_MON: u8 = 0x4E;
/// WIDEBAND EXPAK
pub const DATA_PROTO_WB_EXPAK: u8 = 0x4F;
/// International Organization for Standardization Internet Protocol
pub const DATA_PROTO_ISO_IP: u8 = 0x50;
/// Versatile Message Transaction Protocol (see RFC 1045)
pub const DATA_PROTO_VMTP: u8 = 0x51;
/// Secure Versatile Message Transaction Protocol (see RFC 1045)
pub const DATA_PROTO_SECURE_VMTP: u8 = 0x52;
/// VINES
pub const DATA_PROTO_VINES: u8 = 0x53;
/// Time-Triggered Protocol
pub const DATA_PROTO_TTP: u8 = 0x54;
/// NSFNET-IGP
pub const DATA_PROTO_NSFNET_IGP: u8 = 0x55;
/// Dissimilar Gateway Protocol
pub const DATA_PROTO_DGP: u8 = 0x56;
/// TCF
pub const DATA_PROTO_TCF: u8 = 0x57;
/// EIGRP Informational (see RFC 7868)
pub const DATA_PROTO_EIGRP: u8 = 0x58;
/// Open Shortest Path First (see RFC 2328)
pub const DATA_PROTO_OSPF: u8 = 0x59;
/// Sprite RPC Protocol
pub const DATA_PROTO_SPRITE_RPC: u8 = 0x5A;
/// Locus Address Resolution Protocol
pub const DATA_PROTO_LARP: u8 = 0x5B;
/// Multicast Transport Protocol
pub const DATA_PROTO_MTP: u8 = 0x5C;
/// AX.25
pub const DATA_PROTO_AX25: u8 = 0x5D;
/// KA9Q NOS compatible IP over IP tunneling
pub const DATA_PROTO_KA9QNOS: u8 = 0x5E;
/// Mobile Internetworking Control Protocol
pub const DATA_PROTO_MICP: u8 = 0x5F;
/// Semaphore Communications Sec. Pro
pub const DATA_PROTO_SCCSP: u8 = 0x60;
/// Ethernet-within-IP Encapsulation (see RFC 3378)
pub const DATA_PROTO_ETHERIP: u8 = 0x61;
/// Encapsulation Header (see RFC 1241)
pub const DATA_PROTO_ENCAP: u8 = 0x62;
/// Any private encryption scheme
pub const DATA_PROTO_ANY_PRIVATE_ENCRYPTION: u8 = 0x63;
/// GMTP
pub const DATA_PROTO_GMTP: u8 = 0x64;
/// Ipsilon Flow Management Protocol
pub const DATA_PROTO_IFMP: u8 = 0x65;
/// PNNI over IP
pub const DATA_PROTO_PNNI: u8 = 0x66;
/// Protocol Independent Multicast
pub const DATA_PROTO_PIM: u8 = 0x67;
/// IBM's ARIS (Aggregate Route IP Switching) Protocol
pub const DATA_PROTO_ARIS: u8 = 0x68;
/// SCPS (Space Communications Protocol Standards) (see SCPS-TP)
pub const DATA_PROTO_SCPS: u8 = 0x69;
/// QNX
pub const DATA_PROTO_QNX: u8 = 0x6A;
/// Active Networks
pub const DATA_PROTO_ACTIVE_NETWORKS: u8 = 0x6B;
/// IP Payload Compression Protocol (see RFC 3173)
pub const DATA_PROTO_IP_COMP: u8 = 0x6C;
/// Sitara Networks Protocol
pub const DATA_PROTO_SNP: u8 = 0x6D;
/// Compaq Peer Protocol
pub const DATA_PROTO_COMPAQ_PEER: u8 = 0x6E;
/// IPX in IP
pub const DATA_PROTO_IPX_IN_IP: u8 = 0x6F;
/// Virtual Router Redundancy Protocol, Common Address Redundancy Protocol (not IANA assigned) (see RFC 5798)
pub const DATA_PROTO_VRRP: u8 = 0x70;
/// PGM Reliable Transport Protocol (see RFC 3208)
pub const DATA_PROTO_PGM: u8 = 0x71;
/// Any 0-hop protocol
pub const DATA_PROTO_ANY_0_HOP: u8 = 0x72;
/// Layer Two Tunneling Protocol Version 3 (see RFC 3931)
pub const DATA_PROTO_L2TP: u8 = 0x73;
/// D-II Data Exchange (DDX)
pub const DATA_PROTO_DDX: u8 = 0x74;
/// Interactive Agent Transfer Protocol
pub const DATA_PROTO_IATP: u8 = 0x75;
/// Schedule Transfer Protocol
pub const DATA_PROTO_STP: u8 = 0x76;
/// SpectraLink Radio Protocol
pub const DATA_PROTO_SRP: u8 = 0x77;
/// Universal Transport Interface Protocol
pub const DATA_PROTO_UTI: u8 = 0x78;
/// Simple Message Protocol
pub const DATA_PROTO_SMP: u8 = 0x79;
/// Simple Multicast Protocol
pub const DATA_PROTO_SM: u8 = 0x7A;
/// Performance Transparency Protocol
pub const DATA_PROTO_PTP: u8 = 0x7B;
/// Intermediate System to Intermediate System (IS-IS) Protocol over IPv4 (see RFC 1142, RFC 1195)
pub const DATA_PROTO_IS_IS_OVER_IPV4: u8 = 0x7C;
/// Flexible Intra-AS Routing Environment
pub const DATA_PROTO_FIRE: u8 = 0x7D;
/// Combat Radio Transport Protocol
pub const DATA_PROTO_CRTP: u8 = 0x7E;
/// Combat Radio User Datagram
pub const DATA_PROTO_CRUDP: u8 = 0x7F;
/// Service-Specific Connection-Oriented Protocol in a Multilink and Connectionless Environment (see ITU-T Q.2111 1999)
pub const DATA_PROTO_SSCOPMCE: u8 = 0x80;
/// IPLT
pub const DATA_PROTO_IPLT: u8 = 0x81;
/// Secure Packet Shield
pub const DATA_PROTO_SPS: u8 = 0x82;
/// Private IP Encapsulation within IP
pub const DATA_PROTO_PIPE: u8 = 0x83;
/// Stream Control Transmission Protocol (see RFC 4960)
pub const DATA_PROTO_SCTP: u8 = 0x84;
/// Fibre Channel
pub const DATA_PROTO_FC: u8 = 0x85;
/// Reservation Protocol (RSVP) End-to-End Ignore (see RFC 3175)
pub const DATA_PROTO_RSVP_E2E_IGNORE: u8 = 0x86;
/// Mobility Extension Header for IPv6 (see RFC 6275)
pub const DATA_PROTO_MOBILITY_HEADER: u8 = 0x87;
/// Lightweight User Datagram Protocol (see RFC 3828)
pub const DATA_PROTO_UDP_LITE: u8 = 0x88;
/// Multiprotocol Label Switching Encapsulated in IP (see RFC 4023, RFC 5332)
pub const DATA_PROTO_MPLS_IN_IP: u8 = 0x89;
/// MANET Protocols (see RFC 5498)
pub const DATA_PROTO_MANET: u8 = 0x8A;
/// Host Identity Protocol (see RFC 5201)
pub const DATA_PROTO_HIP: u8 = 0x8B;
/// Site Multihoming by IPv6 Intermediation (see RFC 5533)
pub const DATA_PROTO_SHIM6: u8 = 0x8C;
/// Wrapped Encapsulating Security Payload (see RFC 5840)
pub const DATA_PROTO_WESP: u8 = 0x8D;
/// Robust Header Compression (see RFC 5856)
pub const DATA_PROTO_ROHC: u8 = 0x8E;
/// IPv6 Segment Routing (TEMPORARY - registered 2020-01-31, expired 2021-01-31)  
pub const DATA_PROTO_ETHERNET: u8 = 0x8F;
/// Use for experimentation and testing
pub const DATA_PROTO_EXP1: u8 = 0xFD;
/// Use for experimentation and testing
pub const DATA_PROTO_EXP2: u8 = 0xFE;
/// Reserved value
pub const DATA_PROTO_DATA_PROTO_RESERVED: u8 = 0xFF;

/// End of Option List
pub const OPT_TYPE_EOOL: u8 = 0x00;
/// No Operation
pub const OPT_TYPE_NOP: u8 = 0x01;
/// Security (defunct option)
pub const OPT_TYPE_SEC: u8 = 0x02;
/// Record Route
pub const OPT_TYPE_RR: u8 = 0x07;
/// Experimental Measurement
pub const OPT_TYPE_ZSU: u8 = 0x0A;
/// MTU Probe
pub const OPT_TYPE_MTUP: u8 = 0x0B;
/// MTU Reply
pub const OPT_TYPE_MTUR: u8 = 0x0C;
/// ENCODE
pub const OPT_TYPE_ENCODE: u8 = 0x0F;
/// Quick-Start
pub const OPT_TYPE_QS: u8 = 0x19;
/// RFC 3692 Experiment
pub const OPT_TYPE_EXP1: u8 = 0x1E;
// Time Stamp
pub const OPT_TYPE_TS: u8 = 0x44;
/// Traceroute
pub const OPT_TYPE_TR: u8 = 0x52;
/// RFC 3692 Experiment
pub const OPT_TYPE_EXP2: u8 = 0x5E;
/// Security (RIPSO)
pub const OPT_TYPE_RIPSO: u8 = 0x82;
/// Loose Source Route
pub const OPT_TYPE_LSR: u8 = 0x83;
/// Extended Security (RIPSO)
pub const OPT_TYPE_ESEC: u8 = 0x85;
/// Commercial IP Security
pub const OPT_TYPE_CIPSO: u8 = 0x86;
/// Stream ID
pub const OPT_TYPE_SID: u8 = 0x88;
/// Strict Source Route
pub const OPT_TYPE_SSR: u8 = 0x89;
/// Experimental Access Control
pub const OPT_TYPE_VISA: u8 = 0x8E;
/// IMI Traffic Descriptor
pub const OPT_TYPE_IMITD: u8 = 0x90;
/// Extended Internet Protocol
pub const OPT_TYPE_EIP: u8 = 0x91;
/// Address Extension
pub const OPT_TYPE_ADD_EXT: u8 = 0x93;
/// Router Alert
pub const OPT_TYPE_RTR_ALT: u8 = 0x94;
/// Selective Directed Broadcast
pub const OPT_TYPE_SDB: u8 = 0x95;
/// Dynamic Packet State
pub const OPT_TYPE_DPS: u8 = 0x97;
/// Upstream Multicast Packet
pub const OPT_TYPE_UMP: u8 = 0x98;
/// RFC 3692 Experiment
pub const OPT_TYPE_EXP3: u8 = 0x9E;
/// Experimental Flow Control
pub const OPT_TYPE_FINN: u8 = 0xCD;
/// RFC 3692 Experiment
pub const OPT_TYPE_EXP4: u8 = 0xDE;

pub const OPT_CLASS_CONTROL: u8 = 0;
pub const OPT_CLASS_RESERVED1: u8 = 1;
pub const OPT_CLASS_DEBUGGING_MEASUREMENT: u8 = 2;
pub const OPT_CLASS_RESERVED3: u8 = 3;

/// An IPv4 (Internet Protocol version 4) packet.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |Version|  IHL  |    DSCP   |ECN|         Packet Length         |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  4 |          Fragment ID          |Flags|   Fragmentation Offset  |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  8 |  Time To Live |    Protocol   |            Checksum           |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 12 |                         Source Address                        |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 16 |                      Destination Address                      |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 20 Z                       0 or more Options                       Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ?? Z                            Payload                            Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Clone, Debug, Layer, StatelessLayer)]
#[metadata_type(Ipv4Metadata)]
#[ref_type(Ipv4Ref)]
pub struct Ipv4 {
    // version, ihl, length, protocol, and checksum all calculated dynamically
    dscp: DiffServ, // also known as ToS
    ecn: Ecn,
    id: u16,
    flags: Ipv4Flags,
    frag_offset: u16,
    ttl: u8,
    chksum: Option<u16>,
    src: u32,
    dst: u32,
    options: Ipv4Options,
    payload: Option<Box<dyn LayerObject>>,
}

impl Ipv4 {
    /// The Internet Header Length (IHL) of the packet.
    ///
    /// This field indicates the number of bytes in the header of the IPv4 packet as a multiple of 4.
    /// So, an IHL of 8 would indicate that the first 32 bytes of the packet are the IPv4 header.
    /// The IHL must be a minimum of 20 bytes (i.e. a value of 5) to cover the necessary mandatory IPv4
    /// fields, and cannot exceed 60 bytes (i.e. a value of 15).
    ///
    /// As an implementation-specific detail, the IHL is automatically calculated and cannot be manually
    /// set in an [`Ipv4`] object. This is because the IHL determines the number of bytes in the options field,
    /// and changing the IHL without changing the options would break the packet's structural composition.
    /// With this in mind, if it is still desirable to modify the IHL of a packet, see [`Ipv4Mut`]
    /// (specifically the `set_ihl_unchecked()` method).
    #[inline]
    pub fn ihl(&self) -> u8 {
        let len = self.options.byte_len();
        assert!(len < (10 * 4), "Ipv4 packet had too many bytes in options to represent in the Internet Header Length (IHL) field");
        5 + (len / 4) as u8
    }

    /// The Differentiated Services Code Point (DSCP) of the packet.
    ///
    /// More information on this field can be found in RFC 2474.
    #[inline]
    pub fn dscp(&self) -> DiffServ {
        self.dscp
    }

    /// Sets the Differentiated Services Code Point (DSCP) of the packet.
    ///
    /// More information on this field can be found in RFC 2474.
    #[inline]
    pub fn set_dscp(&mut self, dscp: DiffServ) {
        self.dscp = dscp;
    }

    /// The Explicit Congestion Notification (ECN) field of the packet.
    ///
    /// More information on this field can be found in the [`Ecn`] documentation.
    /// or in RFC 3168.
    #[inline]
    pub fn ecn(&self) -> Ecn {
        self.ecn
    }

    /// Sets the Explicit Congestion Notification (ECN) field of the packet.
    ///
    /// More information on this field can be found in the [`Ecn`] documentation.
    /// or in RFC 3168.
    #[inline]
    pub fn set_ecn(&mut self, ecn: Ecn) {
        self.ecn = ecn;
    }

    /// The combined length (in bytes) of the packet's header and payload.
    ///
    /// This method will return the same integer value as [`Ipv4::len()`] if the
    /// total packet size is less than or equal to 65535 bytes (i.e. the size
    /// will fit in an unsigned 16-bit field). If the total packet size is greater
    /// than 65535 bytes, it will return `None`.
    #[inline]
    pub fn packet_length(&self) -> Option<u16> {
        self.len().try_into().ok()
    }

    /// The Identifier field of the IPv4 packet, used for the purpose of reassembling
    /// fragmented packets.
    ///
    /// This field has occasionally been used in contexts other than fragmentation,
    /// such as datagram deduplication. However, RFC 6864 now explicitly disallows
    /// such use:
    ///
    /// "The IPv4 ID field MUST NOT be used for purposes other than
    ///  fragmentation and reassembly."
    ///
    /// This RFC also mandates that the ID field has no meaning for atomic (unfragmented)
    /// packets, so it may be set to any value when the MF (More Fragments) flag is not set
    /// _and_ the Fragment Offset field is 0.
    #[inline]
    pub fn identifier(&self) -> u16 {
        self.id
    }

    /// Sets the Identifier field of the IPv4 packet.
    ///
    /// For more information on the Identifier field, see the
    /// [`Ipv4::identifier()`] method.
    #[inline]
    pub fn set_identifier(&mut self, id: u16) {
        self.id = id;
    }

    /// The flags of the IPv4 packet.
    ///
    /// See [`Ipv4Flags`] for more details on specific IPv4 flags and their uses.
    #[inline]
    pub fn flags(&self) -> Ipv4Flags {
        self.flags
    }

    /// Sets the flags of the IPv4 packet.
    ///
    /// See [`Ipv4Flags`] for more details on specific IPv4 flags and their uses.
    #[inline]
    pub fn set_flags(&mut self, flags: Ipv4Flags) {
        self.flags = flags;
    }

    /// The fragmentation offset of the packet.
    ///
    /// If this value is not zero, it denotes that the packet's payload is a
    /// portion of a larger IPv4 payload that has been fragmented into several
    /// distinct packets. The offset indicates where this packet's payload fits
    /// relative to other fragments during reassembly.
    ///
    /// IPv4 fragments are specified in 8-byte size increments, so the fragmentation
    /// offset should be multiplied by 8 to obtain the actual byte offset of the
    /// packet's contents.
    #[inline]
    pub fn frag_offset(&self) -> u16 {
        self.frag_offset
    }

    /// Sets the fragmentation offset of the packet.
    ///
    /// For more information on the Fragment Offset field, see the
    /// [Ipv4::frag_offset()`] method.
    #[inline]
    pub fn set_frag_offset(&mut self, offset: u16) {
        assert!(offset <= 0b_0001_1111_1111_1111);
        self.frag_offset = offset;
    }

    /// The Time-To-Live (TTL) field of the packet.
    ///
    /// This field is most commonly used to denote the number of routing hops a
    /// packet should travel before being dropped. When a router receives an IPv4
    /// packet, it checks the TTL field of the packet. If the TTL is 0, the router
    /// drops the packet and optionally sends an ICMP "Time Exceeded" packet back
    /// to the address that sent the packet; otherwise, it decrements the value of
    /// the TTL by 1 and routes the packet to its next hop.
    ///
    /// the TTL field is primarily used to avoid resource exhaustion in the event
    /// that a routing loop forms, though tools like `traceroute` also use its
    /// functionality to identify routing paths across a network.
    #[inline]
    pub fn ttl(&self) -> u8 {
        self.ttl
    }

    /// Sets the Time-To-Live (TTL) field of the packet.
    ///
    /// For more information on the TTL field, see the [`Ipv4::ttl()`] method.
    #[inline]
    pub fn set_ttl(&mut self, ttl: u8) {
        self.ttl = ttl;
    }

    /// A single byte value that identifies the protocol of the packet's payload.
    ///
    /// This field is automatically determined based on the payload of the packet
    /// and cannot be manually set. If such functionality is desired, use
    /// [`Ipv4Mut::set_protocol()`].
    #[inline]
    pub fn protocol(&self) -> u8 {
        match self.payload.as_ref() {
            None => DATA_PROTO_EXP1,
            Some(p) => {
                let payload_metadata = p
                    .layer_metadata()
                    .as_any()
                    .downcast_ref::<&dyn Ipv4PayloadMetadata>()
                    .expect("unknown payload protocol found in IPv4 packet");
                payload_metadata.ip_data_protocol()
            }
        }
    }

    /// Retrieves the assigned checksum for the packet, or `None` if no checksum has explicitly
    /// been assigned to the packet.
    ///
    /// By default, the IPv4 checksum is automatically calculated when an [`Ipv4`] instance is
    /// converted to bytes, unless a checksum is pre-assigned to the instance prior to conversion.
    /// If a checksum has already been assigned to the packet, this method will return it;
    /// otherwise, it will return `None`. This means that an [`Ipv4`] instance created from bytes
    /// or from a [`Ipv4Ref`] instance will still have a checksum of `None` by default, regardless
    /// of the checksum value of the underlying bytes it was created from.
    #[inline]
    pub fn chksum(&self) -> Option<u16> {
        self.chksum
    }

    /// Assigns a checksum to be used for the packet.
    ///
    /// By default, the IPv4 checksum is automatically calculated when an [`Ipv4`] instance is
    /// converted to bytes. This method overrides that behavior so that the provided checksum is
    /// used instead. You generally shouldn't need to use this method unless:
    ///   1. You know the expected checksum of the packet in advance and don't want the checksum
    ///      calculation to automatically run again (since it can be a costly operation), or
    ///   2. Checksum offloading is being employed for the IPv4 packet and you want to zero out the
    ///      checksum field (again, avoiding unnecessary extra computation), or
    ///   3. You want to explicitly set an invalid checksum.
    #[inline]
    pub fn set_chksum(&mut self, chksum: u16) {
        self.chksum = Some(chksum);
    }

    /// Clears any previously assigned checksum for the packet.
    ///
    /// This method guarantees that the IPv4 checksum will be automatically calculated for this
    /// [`Ipv4`] instance whenever the packet is converted to bytes. You shouldn't need to call
    /// this method unless you've previously explicitly assigned a checksum to the packet--either
    /// through a call to [`Ipv4::set_chksum()`] or through a Builder pattern. Packets converted
    /// from bytes into [`Ipv4`] instances from bytes or from a [`Ipv4Ref`] instance will have a
    /// checksum of `None` by default.
    pub fn clear_chksum(&mut self) {
        self.chksum = None;
    }

    /// The source IP address of the packet.
    #[inline]
    pub fn src(&self) -> u32 {
        self.src
    }

    /// Sets the source IP address of the packet.
    #[inline]
    pub fn set_src(&mut self, src: u32) {
        self.src = src;
    }

    /// The destination IP address of the packet.
    #[inline]
    pub fn dst(&self) -> u32 {
        self.dst
    }

    /// Sets the destination IP address of the packet.
    #[inline]
    pub fn set_dst(&mut self, dst: u32) {
        self.dst = dst;
    }

    /// The Ipv4 Options fields of the packet.
    pub fn options(&self) -> &Ipv4Options {
        &self.options
    }

    /// A mutable reference to the Ipv4 Options fields of the packet.
    pub fn options_mut(&mut self) -> &mut Ipv4Options {
        &mut self.options
    }
}

impl FromBytesCurrent for Ipv4 {
    #[inline]
    fn from_bytes_current_layer_unchecked(bytes: &[u8]) -> Self {
        let ipv4 = Ipv4Ref::from_bytes_unchecked(bytes);
        Ipv4 {
            dscp: ipv4.dscp(),
            ecn: ipv4.ecn(),
            id: ipv4.identifier(),
            flags: ipv4.flags(),
            frag_offset: ipv4.frag_offset(),
            ttl: ipv4.ttl(),
            chksum: None,
            src: ipv4.src(),
            dst: ipv4.dst(),
            options: Ipv4Options::from(ipv4.options()),
            payload: None,
        }
    }

    #[inline]
    fn payload_from_bytes_unchecked_default(&mut self, bytes: &[u8]) {
        let ipv4 = Ipv4Ref::from_bytes_unchecked(bytes);
        if ipv4.payload_raw().is_empty() {
            self.payload = None;
        } else {
            self.payload = match ipv4.protocol() {
                DATA_PROTO_TCP => Some(Box::new(Tcp::from_bytes_unchecked(ipv4.payload_raw()))),
                DATA_PROTO_UDP => Some(Box::new(Udp::from_bytes_unchecked(ipv4.payload_raw()))),
                DATA_PROTO_SCTP => Some(Box::new(Sctp::from_bytes_unchecked(ipv4.payload_raw()))),
                /* Add additional protocols here */
                _ => Some(Box::new(Raw::from_bytes_unchecked(ipv4.payload_raw()))),
            };
        }
    }
}

impl LayerLength for Ipv4 {
    /// The total length (in bytes) of the Ipv4 header and payload.
    fn len(&self) -> usize {
        20 + self.options.byte_len()
            + match self.payload.as_ref() {
                Some(p) => p.len(),
                None => 0,
            }
    }
}

impl LayerObject for Ipv4 {
    #[inline]
    fn can_set_payload_default(&self, payload: &dyn LayerObject) -> bool {
        payload
            .layer_metadata()
            .as_any()
            .downcast_ref::<&dyn Ipv4PayloadMetadata>()
            .is_some()
    }

    #[inline]
    fn get_payload_ref(&self) -> Option<&dyn LayerObject> {
        self.payload.as_deref()
    }

    #[inline]
    fn get_payload_mut(&mut self) -> Option<&mut dyn LayerObject> {
        self.payload.as_deref_mut()
    }

    #[inline]
    fn set_payload_unchecked(&mut self, payload: Box<dyn LayerObject>) {
        self.payload = Some(payload);
    }

    #[inline]
    fn has_payload(&self) -> bool {
        self.payload.is_some()
    }

    #[inline]
    fn remove_payload(&mut self) -> Box<dyn LayerObject> {
        let mut ret = None;
        core::mem::swap(&mut ret, &mut self.payload);
        self.payload = None;
        ret.expect("remove_payload() called on IPv4 layer when layer had no payload")
    }
}

impl ToBytes for Ipv4 {
    fn to_bytes_chksummed(&self, bytes: &mut Vec<u8>, _prev: Option<(LayerId, usize)>) {
        let start = bytes.len();
        bytes.push(0x40 | self.ihl());
        bytes.push((self.dscp.dscp() << 2) | self.ecn as u8);
        bytes.extend(u16::try_from(self.len()).unwrap_or(0xFFFF).to_be_bytes()); // WARNING: packets with contents greater than 65535 bytes will have their length field truncated
        bytes.extend(self.id.to_be_bytes());
        bytes.extend((((self.flags.flags as u16) << 8) | self.frag_offset).to_be_bytes());
        bytes.push(self.ttl);
        bytes.push(
            self.payload
                .as_ref()
                .map(|p| {
                    p.layer_metadata()
                        .as_any()
                        .downcast_ref::<&dyn Ipv4PayloadMetadata>()
                        .map(|m| m.ip_data_protocol())
                        .expect("unknown payload protocol found in IPv4 packet")
                })
                .unwrap_or(DATA_PROTO_EXP1) as u8,
        ); // 0xFD when no payload specified
        bytes.extend(self.chksum.unwrap_or(0).to_be_bytes());
        bytes.extend(self.src.to_be_bytes());
        bytes.extend(self.dst.to_be_bytes());
        self.options.to_bytes_extended(bytes);
        if let Some(payload) = self.payload.as_ref() {
            payload.to_bytes_chksummed(bytes, Some((Self::layer_id(), start)))
        }

        if self.chksum.is_none() {
            let chksum_field: &mut [u8; 2] = &mut bytes[start + 10..start + 12].try_into().unwrap();
            *chksum_field = utils::ones_complement_16bit(&bytes[start..]).to_be_bytes();
        }
    }
}

/// An IPv4 (Internet Protocol version 4) packet.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |Version|  IHL  |    DSCP   |ECN|         Packet Length         |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  4 |          Fragment ID          |Flags|   Fragmentation Offset  |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  8 |  Time To Live |    Protocol   |            Checksum           |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 12 |                         Source Address                        |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 16 |                      Destination Address                      |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 20 Z                       0 or more Options                       Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ?? Z                            Payload                            Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Copy, Clone, Debug, LayerRef, StatelessLayer)]
#[owned_type(Ipv4)]
#[metadata_type(Ipv4Metadata)]
pub struct Ipv4Ref<'a> {
    #[data_field]
    data: &'a [u8],
}

impl<'a> Ipv4Ref<'a> {
    /// The Internet Protocol Version field of the packet (should be equal to 4).
    #[inline]
    pub fn version(&self) -> u8 {
        self.data
            .first()
            .expect("insufficient bytes in IPv4 packet to retrieve IP Version field")
            >> 4
    }

    /// The Internet Header Length (IHL) of the packet.
    ///
    /// The number of bytes present in the IPv4 header (and, by extension, the
    /// number of bytes of IPv4 Options) is determined by multiplying this value
    /// by 4. The IHL must be a minimum value of 5, as the first 20 bytes of the
    /// IPv4 header are required.
    #[inline]
    pub fn ihl(&self) -> u8 {
        self.data
            .first()
            .expect("insufficient bytes in IPv4 packet to retrieve Internet Header Length field")
            & 0x0F
    }

    /// The Differentiated Services Code Point (DSCP) of the packet.
    ///
    /// More information on this field can be found in RFC 2474.
    #[inline]
    pub fn dscp(&self) -> DiffServ {
        DiffServ::from(*self.data.get(1).expect("insufficient bytes in IPv4 packet to retrieve Differentiated Services Code Point (DSCP) field"))
    }

    /// The Explicit Congestion Notification (ECN) field of the packet.
    ///
    /// More information on this field can be found in the [`Ecn`] documentation.
    #[inline]
    pub fn ecn(&self) -> Ecn {
        Ecn::from(*self.data.get(1).expect(
            "insufficient bytes in IPv4 packet to retrieve Explicit Congestion Notification field",
        ))
    }

    /// The combined length (in bytes) of the packet's header and payload.
    #[inline]
    pub fn packet_length(&self) -> u16 {
        u16::from_be_bytes(
            self.data[2..4]
                .try_into()
                .expect("insufficient bytes in IPv4 packet to retrieve Packet Length field"),
        )
    }

    /// The Identifier field of the IPv4 packet, used for the purpose of reassembling
    /// fragmented packets.
    ///
    /// This field has occasionally been used in contexts other than fragmentation,
    /// such as datagram deduplication. However, RFC 6864 now explicitly disallows
    /// such use:
    ///
    /// "The IPv4 ID field MUST NOT be used for purposes other than
    ///  fragmentation and reassembly."
    ///
    /// This RFC also mandates that the ID field has no meaning for atomic (unfragmented)
    /// packets, so it may be set to any value when the MF (More Fragments) flag is not set
    /// _and_ the Fragment Offset field is 0.
    #[inline]
    pub fn identifier(&self) -> u16 {
        u16::from_be_bytes(
            self.data
                .get(4..6)
                .expect("insufficient bytes in IPv4 packet to retrieve Identifier field")
                .try_into()
                .unwrap(),
        )
    }

    /// The flags of the IPv4 packet.
    ///
    /// See [`Ipv4Flags`] for more details on specific IPv4 flags and their uses.
    #[inline]
    pub fn flags(&self) -> Ipv4Flags {
        Ipv4Flags::from(
            *self
                .data
                .get(6)
                .expect("insufficient bytes in IPv4 packet to retrieve Flags field"),
        )
    }

    /// The fragmentation offset of the packet.
    ///
    /// If this value is not zero, it denotes that the packet's payload is a
    /// portion of a larger IPv4 payload that has been fragmented into several
    /// distinct packets. The offset indicates where this packet's payload fits
    /// relative to other fragments during reassembly.
    ///
    /// IPv4 fragments are specified in 8-byte size increments, so the fragmentation
    /// offset should be multiplied by 8 to obtain the actual byte offset of the
    /// packet's contents.
    #[inline]
    pub fn frag_offset(&self) -> u16 {
        u16::from_be_bytes(
            self.data
                .get(6..8)
                .expect("insufficient bytes in IPv4 packet to retrieve Fragmentation Offset field")
                .try_into()
                .unwrap(),
        ) & 0b0001111111111111
    }

    /// The Time-To-Live (TTL) field of the packet.
    ///
    /// This field is most commonly used to denote the number of routing hops a
    /// packet should travel before being dropped. When a router receives an IPv4
    /// packet, it checks the TTL field of the packet. If the TTL is 0, the router
    /// drops the packet and optionally sends an ICMP "Time Exceeded" packet back
    /// to the address that sent the packet; otherwise, it decrements the value of
    /// the TTL by 1 and routes the packet to its next hop.
    ///
    /// the TTL field is primarily used to avoid resource exhaustion in the event
    /// that a routing loop forms, though tools like `traceroute` also use its
    /// functionality to identify routing paths across a network.
    #[inline]
    pub fn ttl(&self) -> u8 {
        *self
            .data
            .get(8)
            .expect("insufficient bytes in IPv4 packet to retrieve Time To Live field")
    }

    /// A single byte value that identifies the protocol of the packet's payload.
    ///
    /// This field is automatically determined based on the payload of the packet
    /// and cannot be manually set. If such functionality is desired, use
    /// [`Ipv4Mut::set_protocol()`].
    #[inline]
    pub fn protocol(&self) -> u8 {
        *self
            .data
            .get(9)
            .expect("insufficient bytes in IPv4 packet to retrieve Protocol field")
    }

    /// The checksum of the packet, calculated across the entirity of the
    /// packet's header and payload data.
    #[inline]
    pub fn chksum(&self) -> u16 {
        u16::from_be_bytes(
            self.data
                .get(10..12)
                .expect("insufficient bytes in IPv4 packet to retrieve Checksum field")
                .try_into()
                .unwrap(),
        )
    }

    /// The source IP address of the packet.
    #[inline]
    pub fn src(&self) -> u32 {
        u32::from_be_bytes(
            self.data
                .get(12..16)
                .expect("insufficient bytes in IPv4 packet to retrieve Source IP Address field")
                .try_into()
                .unwrap(),
        )
    }

    /// The destination IP address of the packet.
    #[inline]
    pub fn dst(&self) -> u32 {
        u32::from_be_bytes(
            self.data
                .get(16..20)
                .expect(
                    "insufficient bytes in IPv4 packet to retrieve Destination IP Address field",
                )
                .try_into()
                .unwrap(),
        )
    }

    /// The Ipv4 Options fields of the packet.
    #[inline]
    pub fn options(&self) -> Ipv4OptionsRef<'a> {
        let options_end = core::cmp::min(self.ihl(), 5) as usize * 4;
        Ipv4OptionsRef::from_bytes_unchecked(
            self.data
                .get(20..options_end)
                .expect("insufficient bytes in IPv4 packet to retrieve Ipv4 Options fields"),
        )
    }

    /// The payload of the packet.
    #[inline]
    pub fn payload_raw(&self) -> &[u8] {
        let options_end = core::cmp::min(self.ihl(), 5) as usize * 4;
        &self
            .data
            .get(options_end..)
            .expect("insufficient bytes in IPv4 packet to retrieve payload")
    }
}

impl<'a> FromBytesRef<'a> for Ipv4Ref<'a> {
    #[inline]
    fn from_bytes_unchecked(packet: &'a [u8]) -> Self {
        Ipv4Ref { data: packet }
    }
}

impl LayerOffset for Ipv4Ref<'_> {
    fn payload_byte_index_default(bytes: &[u8], layer_type: LayerId) -> Option<usize> {
        let ihl = match bytes.first() {
            Some(l) => cmp::max((l & 0x0F) as usize, 5) * 4,
            None => return None,
        };

        match bytes.get(9).map(|b| *b) {
            Some(DATA_PROTO_TCP) => {
                if layer_type == Tcp::layer_id() {
                    Some(ihl)
                } else {
                    TcpRef::payload_byte_index_default(&bytes[ihl..], layer_type)
                        .map(|val| ihl + val)
                }
            }
            Some(DATA_PROTO_UDP) => {
                if layer_type == Udp::layer_id() {
                    Some(ihl)
                } else {
                    UdpRef::payload_byte_index_default(&bytes[ihl..], layer_type)
                        .map(|val| ihl + val)
                }
            }
            Some(DATA_PROTO_SCTP) => {
                if layer_type == Sctp::layer_id() {
                    Some(ihl)
                } else {
                    SctpRef::payload_byte_index_default(&bytes[ihl..], layer_type)
                        .map(|val| ihl + val)
                }
            }
            _ => {
                if layer_type == Raw::layer_id() {
                    Some(ihl)
                } else {
                    None
                }
            }
        }
    }
}

impl Validate for Ipv4Ref<'_> {
    #[inline]
    fn validate_current_layer(curr_layer: &[u8]) -> Result<(), ValidationError> {
        let (version, ihl) =
            match curr_layer.first() {
                None => return Err(ValidationError {
                    layer: Ipv4::name(),
                    err_type: ValidationErrorType::InsufficientBytes,
                    reason:
                        "packet too short for Ipv4 frame--missing version/IHL byte in Ipv4 header",
                }),
                Some(&b) => (b >> 4, (b & 0x0F) as usize * 4),
            };

        let total_length = match curr_layer
            .get(2..4)
            .and_then(|s| <[u8; 2]>::try_from(s).ok())
        {
            None => {
                return Err(ValidationError {
                    layer: Ipv4::name(),
                    err_type: ValidationErrorType::InsufficientBytes,
                    reason:
                        "packet too short for Ipv4 frame--missing length field bytes in Ipv4 header",
                })
            }
            Some(s) => u16::from_be_bytes(s) as usize,
        };

        if total_length > curr_layer.len() {
            return Err(ValidationError {
                layer: Ipv4::name(),
                err_type: ValidationErrorType::InsufficientBytes,
                reason: "total packet length reported in Ipv4 header exceeded the available bytes",
            });
        }

        // Now that InvalidSize errors have been checked, we validate values
        if version != 4 {
            // Version number not 4 (required for Ipv4)
            return Err(ValidationError {
                layer: Ipv4::name(),
                err_type: ValidationErrorType::InvalidValue,
                reason: "version number of Ipv4 header was not equal to 0x04",
            });
        }

        if ihl < 20 {
            // Header length field must be at least 5 (so that corresponding header length is min required 20 bytes)
            return Err(ValidationError {
                layer: Ipv4Ref::name(),
                err_type: ValidationErrorType::InvalidValue,
                reason: "invalid Ipv4 header length value (IHL must be a value of 5 or more)",
            });
        }

        // Validate Ipv4 Options
        let mut remaining_header = &curr_layer[20..ihl];
        while let Some((&option_type, next)) = remaining_header.split_first() {
            match option_type {
                0 => break, // Eool
                1 => remaining_header = next, // Nop
                _ => match remaining_header.get(1) {
                    None => return Err(ValidationError {
                        layer: Ipv4Ref::name(),
                        err_type: ValidationErrorType::InvalidValue,
                        reason: "length field missing from Ipv4 Option",
                    }),
                    Some(0..=1) => return Err(ValidationError {
                        layer: Ipv4Ref::name(),
                        err_type: ValidationErrorType::InvalidValue,
                        reason: "invalid value in Ipv4 Option length field (must be at least 2)",
                    }),
                    Some(&l) => remaining_header = match remaining_header.get(l as usize..) {
                        None => return Err(ValidationError {
                        layer: Ipv4Ref::name(),
                        err_type: ValidationErrorType::InvalidValue,
                        reason: "invalid length field in Ipv4 Option--insufficient option bytes available for specified length",
                        }),
                        Some(r) => r,
                    },
                }
            }
        }

        // Lastly, validate for ExcessBytes
        if total_length < curr_layer.len() {
            Err(ValidationError {
                layer: Ipv4Ref::name(),
                err_type: ValidationErrorType::ExcessBytes(curr_layer.len() - total_length),
                reason:
                    "invalid length field in Ipv4 header--extra bytes remaining at end of packet",
            })
        } else {
            Ok(())
        }
    }

    #[inline]
    fn validate_payload_default(curr_layer: &[u8]) -> Result<(), ValidationError> {
        let ihl =
            match curr_layer.first() {
                Some(l) => (l & 0x0F) as usize * 4,
                None => return Err(ValidationError {
                    layer: Ipv4Ref::name(),
                    err_type: ValidationErrorType::InsufficientBytes,
                    reason:
                        "packet too short for Ipv4 frame--missing version/IHL byte in Ipv4 header",
                }),
            };

        let next_layer =
            match curr_layer.get(ihl..) {
                Some(l) => l,
                None => return Err(ValidationError {
                    layer: Ipv4Ref::name(),
                    err_type: ValidationErrorType::InsufficientBytes,
                    reason:
                        "packet too short for Ipv4 frame--insufficient bytes available for header",
                }),
            };

        match curr_layer.get(9).map(|b| *b) {
            Some(DATA_PROTO_TCP) => TcpRef::validate(next_layer),
            Some(DATA_PROTO_UDP) => UdpRef::validate(next_layer),
            Some(DATA_PROTO_SCTP) => SctpRef::validate(next_layer),
            /* Add more Layer types here */
            _ => RawRef::validate(next_layer),
        }
    }
}

/// An IPv4 (Internet Protocol version 4) packet.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |Version|  IHL  |    DSCP   |ECN|         Packet Length         |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  4 |          Fragment ID          |Flags|   Fragmentation Offset  |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  8 |  Time To Live |    Protocol   |            Checksum           |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 12 |                         Source Address                        |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 16 |                      Destination Address                      |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 20 Z                       0 or more Options                       Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ?? Z                            Payload                            Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Debug, LayerMut, StatelessLayer)]
#[owned_type(Ipv4)]
#[ref_type(Ipv4Ref)]
#[metadata_type(Ipv4Metadata)]
pub struct Ipv4Mut<'a> {
    #[data_field]
    data: &'a mut [u8],
    #[data_length_field]
    len: usize,
}

impl<'a> Ipv4Mut<'a> {
    /// The Internet Protocol Version field of the packet (should be equal to 4).
    #[inline]
    pub fn version(&self) -> u8 {
        self.data
            .first()
            .expect("insufficient bytes in IPv4 packet to retrieve IP Version field")
            >> 4
    }

    /// Sets the Internet Protocol version field of the packet (should be equal to 4).
    #[inline]
    pub fn set_version_unchecked(&mut self, version: u8) {
        let version_byte = self
            .data
            .get_mut(0)
            .expect("insufficient bytes in IPv4 packet to set IP Version field");
        *version_byte = (*version_byte & 0x0F) | (version << 4);
    }

    /// The Internet Header Length (IHL) of the packet.
    ///
    /// The number of bytes present in the IPv4 header (and, by extension, the
    /// number of bytes of IPv4 Options) is determined by multiplying this value
    /// by 4. The IHL must be a minimum value of 5, as the first 20 bytes of the
    /// IPv4 header are required.
    #[inline]
    pub fn ihl(&self) -> u8 {
        self.data
            .first()
            .expect("insufficient bytes in IPv4 packet to retrieve Internet Header Length field")
            & 0x0F
    }

    /// Sets the Internet Header Length (IHL) of the packet.
    #[inline]
    pub fn set_ihl_unchecked(&mut self, ihl: u8) {
        let ihl_field = self
            .data
            .get_mut(0)
            .expect("insufficient bytes in IPv4 packet to set Internet Header Length (IHL) field");
        *ihl_field = (*ihl_field & 0xF0) | (ihl & 0x0F);
    }

    /// The Differentiated Services Code Point (DSCP) of the packet.
    ///
    /// More information on this field can be found in RFC 2474.
    #[inline]
    pub fn dscp(&self) -> DiffServ {
        DiffServ::from(self.data[1])
    }

    /// Sets the Differentiated Services Code Point (DSCP) of the packet.
    ///
    /// More information on this field can be found in RFC 2474.
    #[inline]
    pub fn set_dscp(&mut self, dscp: DiffServ) {
        let dscp_field = self
            .data
            .get_mut(1)
            .expect("insufficient bytes in IPv4 packet to set DSCP field");
        *dscp_field = (*dscp_field & 0b_0000_0011) | (dscp.value << 2);
    }

    /// The Explicit Congestion Notification (ECN) field of the packet.
    ///
    /// More information on this field can be found in the [`Ecn`] documentation.
    #[inline]
    pub fn ecn(&self) -> Ecn {
        Ecn::from(*self.data.get(1).expect(
            "insufficient bytes in IPv4 packet to retrieve Explicit Congestion Notification field",
        ))
    }

    /// Sets the Explicit Congestion Notification (ECN) field of the packet.
    ///
    /// More information on this field can be found in the [`Ecn`] documentation.
    #[inline]
    pub fn set_ecn(&mut self, ecn: Ecn) {
        let ecn_field = self
            .data
            .get_mut(1)
            .expect("insufficient bytes in IPv4 packet to set ECN field");
        *ecn_field = (*ecn_field & 0b_1111_1100) | (ecn as u8 & 0b_0000_0011);
    }

    /// The combined length (in bytes) of the packet's header and payload.
    #[inline]
    pub fn packet_length(&self) -> u16 {
        u16::from_be_bytes(
            self.data[2..4]
                .try_into()
                .expect("insufficient bytes in IPv4 packet to retrieve Packet Length field"),
        )
    }

    /// Sets the combined length (in bytes) of the packet's header and payload.
    #[inline]
    pub fn set_packet_length(&mut self, len: u16) {
        *self
            .data
            .get_mut(2)
            .expect("insufficient bytes in IPv4 packet to set Packet Length field") =
            (len >> 8) as u8;
        *self
            .data
            .get_mut(3)
            .expect("insufficient bytes in IPv4 packet to set Packet Length field") =
            (len & 0xFF) as u8;
    }

    /// The Identifier field of the IPv4 packet, used for the purpose of reassembling
    /// fragmented packets.
    ///
    /// This field has occasionally been used in contexts other than fragmentation,
    /// such as datagram deduplication. However, RFC 6864 now explicitly disallows
    /// such use:
    ///
    /// "The IPv4 ID field MUST NOT be used for purposes other than
    ///  fragmentation and reassembly."
    ///
    /// This RFC also mandates that the ID field has no meaning for atomic (unfragmented)
    /// packets, so it may be set to any value when the MF (More Fragments) flag is not set
    /// _and_ the Fragment Offset field is 0.
    #[inline]
    pub fn identifier(&self) -> u16 {
        u16::from_be_bytes(
            self.data
                .get(4..6)
                .expect("insufficient bytes in IPv4 packet to retrieve Identifier field")
                .try_into()
                .unwrap(),
        )
    }

    #[inline]
    pub fn set_identifier(&mut self, id: u16) {
        self.data[4] = (id >> 8) as u8;
        self.data[5] = (id & 0x00FF) as u8;
    }

    /// The flags of the IPv4 packet.
    ///
    /// See [`Ipv4Flags`] for more details on specific IPv4 flags and their uses.
    #[inline]
    pub fn flags(&self) -> Ipv4Flags {
        Ipv4Flags::from(
            *self
                .data
                .get(6)
                .expect("insufficient bytes in IPv4 packet to retrieve Flags field"),
        )
    }

    #[inline]
    pub fn set_flags(&mut self, flags: Ipv4Flags) {
        self.data[6] &= 0b_0001_1111;
        self.data[6] |= flags.flags;
    }

    /// The fragmentation offset of the packet.
    ///
    /// If this value is not zero, it denotes that the packet's payload is a
    /// portion of a larger IPv4 payload that has been fragmented into several
    /// distinct packets. The offset indicates where this packet's payload fits
    /// relative to other fragments during reassembly.
    ///
    /// IPv4 fragments are specified in 8-byte size increments, so the fragmentation
    /// offset should be multiplied by 8 to obtain the actual byte offset of the
    /// packet's contents.
    #[inline]
    pub fn frag_offset(&self) -> u16 {
        u16::from_be_bytes(
            self.data
                .get(6..8)
                .expect("insufficient bytes in IPv4 packet to retrieve Fragmentation Offset field")
                .try_into()
                .unwrap(),
        ) & 0b0001111111111111
    }

    #[inline]
    pub fn set_frag_offset(&mut self, offset: u16) {
        self.data[6] &= 0b_1110_0000;
        self.data[6] |= ((offset << 8) as u8) & 0b_0001_1111;
        self.data[7] = (offset & 0x00FF) as u8;
    }

    /// The Time-To-Live (TTL) field of the packet.
    ///
    /// This field is most commonly used to denote the number of routing hops a
    /// packet should travel before being dropped. When a router receives an IPv4
    /// packet, it checks the TTL field of the packet. If the TTL is 0, the router
    /// drops the packet and optionally sends an ICMP "Time Exceeded" packet back
    /// to the address that sent the packet; otherwise, it decrements the value of
    /// the TTL by 1 and routes the packet to its next hop.
    ///
    /// the TTL field is primarily used to avoid resource exhaustion in the event
    /// that a routing loop forms, though tools like `traceroute` also use its
    /// functionality to identify routing paths across a network.
    #[inline]
    pub fn ttl(&self) -> u8 {
        *self
            .data
            .get(8)
            .expect("insufficient bytes in IPv4 packet to retrieve Time To Live field")
    }

    #[inline]
    pub fn set_ttl(&mut self, ttl: u8) {
        self.data[8] = ttl;
    }

    /// A single byte value that identifies the protocol of the packet's payload.
    ///
    /// This field is automatically determined based on the payload of the packet
    /// and cannot be manually set. If such functionality is desired, use
    /// [`Ipv4Mut::set_protocol()`].
    #[inline]
    pub fn protocol(&self) -> u8 {
        *self
            .data
            .get(9)
            .expect("insufficient bytes in IPv4 packet to retrieve Protocol field")
    }

    #[inline]
    pub fn set_protocol(&mut self, proto: u8) {
        *self
            .data
            .get_mut(9)
            .expect("insufficient bytes in IPv4 packet to set Protocol field") = proto;
    }

    /// The one's complement checksum of the packet, calculated across the entirity of the packet's
    /// header and payload data.
    #[inline]
    pub fn chksum(&self) -> u16 {
        u16::from_be_bytes(
            self.data
                .get(10..12)
                .expect("insufficient bytes in IPv4 packet to retrieve Checksum field")
                .try_into()
                .unwrap(),
        )
    }

    /// Sets the one's complement checksum to be used for the packet.
    ///
    /// Checksums are _not_ automatically generated for [`Ipv4Mut`] instances, so any changes in a
    /// IPv4 packet's contents should be followed by a corresponding change in the checksum as well.
    /// Checksums _are_ automatically generated for [`Ipv4`] instances, so consider using it instead
    /// of this interface if ease of use is more of a priority than raw speed and performance.
    #[inline]
    pub fn set_chksum(&mut self, chksum: u16) {
        let chksum_field: &mut [u8; 2] = self
            .data
            .get_mut(10..12)
            .expect("insufficient bytes in IPv4 packet to set Checksum field")
            .try_into()
            .unwrap();
        *chksum_field = chksum.to_be_bytes();
    }

    /// The source IP address of the packet.
    #[inline]
    pub fn src(&self) -> u32 {
        u32::from_be_bytes(
            self.data
                .get(12..16)
                .expect("insufficient bytes in IPv4 packet to retrieve Source IP Address field")
                .try_into()
                .unwrap(),
        )
    }

    #[inline]
    pub fn set_src(&mut self, src: u32) {
        self.data[12] = (src >> 24) as u8;
        self.data[13] = ((src >> 16) & 0x000000FF) as u8;
        self.data[14] = ((src >> 8) & 0x000000FF) as u8;
        self.data[15] = (src & 0x000000FF) as u8;
    }

    /// The destination IP address of the packet.
    #[inline]
    pub fn dst(&self) -> u32 {
        u32::from_be_bytes(
            self.data
                .get(16..20)
                .expect(
                    "insufficient bytes in IPv4 packet to retrieve Destination IP Address field",
                )
                .try_into()
                .unwrap(),
        )
    }

    #[inline]
    pub fn set_dst(&mut self, dst: u32) {
        self.data[16] = (dst >> 24) as u8;
        self.data[17] = ((dst >> 16) & 0x000000FF) as u8;
        self.data[18] = ((dst >> 8) & 0x000000FF) as u8;
        self.data[19] = (dst & 0x000000FF) as u8;
    }

    #[inline]
    pub fn options(&'a self) -> Ipv4OptionsRef<'a> {
        let options_end = core::cmp::min(self.ihl(), 5) as usize * 4;
        Ipv4OptionsRef::from_bytes_unchecked(&self.data[20..options_end])
    }

    /*
    #[inline]
    pub fn options_mut(&'a mut self) -> Ipv4OptionsMut<'a> {
        let options_end = core::cmp::min(self.ihl(), 5) as usize * 4;
        Ipv4OptionsMut::from_bytes_unchecked(&mut self.data[20..options_end])
    }
    */

    /*
    pub fn set_options(&mut self, options: Ipv4OptionRef<'_>) {
        todo!()
    }
    */

    #[inline]
    pub fn payload(&self) -> &[u8] {
        &self.data[self.ihl() as usize * 4..]
    }

    pub fn set_payload_unchecked(&mut self, payload: &[u8]) {
        let payload_idx = self.ihl() as usize * 4;
        let payload_destination = self
            .data
            .get_mut(payload_idx..payload_idx + payload.len())
            .expect("insufficient bytes in Ipv4Mut buffer to set payload");
        for (&src, dst) in payload.iter().zip(payload_destination) {
            *dst = src;
        }
        self.len = payload_idx + payload.len();
    }
}

impl<'a> From<&'a Ipv4Mut<'a>> for Ipv4Ref<'a> {
    #[inline]
    fn from(value: &'a Ipv4Mut<'a>) -> Self {
        Ipv4Ref {
            data: &value.data[..value.len],
        }
    }
}

impl<'a> FromBytesMut<'a> for Ipv4Mut<'a> {
    #[inline]
    fn from_bytes_trailing_unchecked(bytes: &'a mut [u8], length: usize) -> Self {
        Ipv4Mut {
            data: bytes,
            len: length,
        }
    }
}

// =============================================================================
//                              INTERNAL FIELDS
// =============================================================================

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct DiffServ {
    value: u8,
}

impl From<u8> for DiffServ {
    fn from(value: u8) -> Self {
        DiffServ { value: value >> 2 }
    }
}

impl DiffServ {
    pub fn dscp(&self) -> u8 {
        self.value
    }
}

/// Explicit Congestion Notification (ECN) values available in an Ipv4 packet.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum Ecn {
    /// Non ECN-Capable Transport
    NonEct = 0b00,
    /// ECN Capable Transport, ECT(0)
    Ect0 = 0b10,
    /// ECN Capable Transport, ECT(1)
    Ect1 = 0b01,
    /// Congestion Encountered
    CgstEnc = 0b11,
}

impl From<u8> for Ecn {
    /// Converts the least significant two bits of the given byte into Explicit Congestion
    /// Notification flags.
    fn from(value: u8) -> Self {
        match (value & 0b10 != 0, value & 0b01 != 0) {
            (false, false) => Ecn::NonEct,
            (false, true) => Ecn::Ect0,
            (true, false) => Ecn::Ect1,
            (true, true) => Ecn::CgstEnc,
        }
    }
}

const RESERVED_BIT: u8 = 0b10000000;
const DONT_FRAGMENT_BIT: u8 = 0b01000000;
const MORE_FRAGMENTS_BIT: u8 = 0b00100000;

/// Flags available in an IPv4 packet
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Ipv4Flags {
    flags: u8,
}

impl Ipv4Flags {
    pub fn reserved(&self) -> bool {
        self.flags & RESERVED_BIT > 0
    }

    pub fn set_reserved(&mut self, reserved: bool) {
        if reserved {
            self.flags |= RESERVED_BIT
        } else {
            self.flags &= !RESERVED_BIT
        }
    }

    pub fn dont_fragment(&self) -> bool {
        self.flags & DONT_FRAGMENT_BIT > 0
    }

    pub fn set_dont_fragment(&mut self, dont_fragment: bool) {
        if dont_fragment {
            self.flags |= DONT_FRAGMENT_BIT
        } else {
            self.flags &= !DONT_FRAGMENT_BIT
        }
    }

    pub fn more_fragments(&self) -> bool {
        self.flags & MORE_FRAGMENTS_BIT > 0
    }

    pub fn set_more_fragments(&mut self, more_fragments: bool) {
        if more_fragments {
            self.flags |= MORE_FRAGMENTS_BIT
        } else {
            self.flags &= !MORE_FRAGMENTS_BIT
        }
    }
}

impl From<u8> for Ipv4Flags {
    /// Converts the most significant 3 bits of the given byte into Ipv4-specific flags.
    fn from(value: u8) -> Self {
        Ipv4Flags {
            flags: value & 0b11100000,
        }
    }
}

#[derive(Clone, Debug)]
pub struct Ipv4Options {
    options: Option<Vec<Ipv4Option>>,
    padding: Option<Vec<u8>>,
}

impl Ipv4Options {
    pub fn from_bytes(bytes: &[u8]) -> Result<Self, ValidationError> {
        Self::validate(bytes)?;
        Ok(Self::from_bytes_unchecked(bytes))
    }

    pub fn from_bytes_unchecked(bytes: &[u8]) -> Self {
        Self::from(Ipv4OptionsRef::from_bytes_unchecked(bytes))
    }

    pub fn validate(bytes: &[u8]) -> Result<(), ValidationError> {
        Ipv4OptionsRef::validate(bytes)
    }

    #[inline]
    pub fn byte_len(&self) -> usize {
        return self.padding.as_ref().map(|p| p.len()).unwrap_or(0)
            + self
                .options
                .as_ref()
                .map(|o| o.iter().map(|o| o.byte_len()).sum())
                .unwrap_or(0);
    }

    #[inline]
    pub fn options(&self) -> &[Ipv4Option] {
        match &self.options {
            None => &[],
            Some(o) => o.as_slice(),
        }
    }

    #[inline]
    pub fn options_mut(&mut self) -> &mut Option<Vec<Ipv4Option>> {
        &mut self.options
    }

    #[inline]
    pub fn padding(&self) -> &[u8] {
        match &self.padding {
            None => &[],
            Some(p) => p.as_slice(),
        }
    }

    #[inline]
    fn to_bytes(&self) -> Vec<u8> {
        let mut v = Vec::new();
        self.to_bytes_extended(&mut v);
        v
    }

    #[inline]
    fn to_bytes_extended(&self, bytes: &mut Vec<u8>) {
        match self.options.as_ref() {
            None => (),
            Some(options) => {
                for option in options.iter() {
                    option.to_bytes_extended(bytes);
                }

                match self.padding.as_ref() {
                    None => (),
                    Some(p) => bytes.extend(p),
                }
            }
        }
    }
}

impl From<&Ipv4OptionsRef<'_>> for Ipv4Options {
    fn from(value: &Ipv4OptionsRef<'_>) -> Self {
        let (options, padding) = if value.iter().next().is_none() {
            (None, None)
        } else {
            let mut opts = Vec::new();
            let mut iter = value.iter();
            while let Some(opt) = iter.next() {
                opts.push(Ipv4Option::from(opt));
            }
            match iter.bytes {
                &[] => (Some(opts), None),
                padding => (Some(opts), Some(Vec::from(padding))),
            }
        };

        Ipv4Options { options, padding }
    }
}

impl From<Ipv4OptionsRef<'_>> for Ipv4Options {
    fn from(value: Ipv4OptionsRef<'_>) -> Self {
        Self::from(&value)
    }
}

#[derive(Clone, Copy, Debug)]
pub struct Ipv4OptionsRef<'a> {
    bytes: &'a [u8],
}

impl<'a> Ipv4OptionsRef<'a> {
    #[inline]
    pub fn from_bytes(bytes: &'a [u8]) -> Result<Self, ValidationError> {
        Self::validate(bytes)?;
        Ok(Self::from_bytes_unchecked(bytes))
    }

    #[inline]
    pub fn from_bytes_unchecked(bytes: &'a [u8]) -> Self {
        Ipv4OptionsRef { bytes }
    }

    pub fn validate(mut bytes: &[u8]) -> Result<(), ValidationError> {
        if bytes.is_empty() {
            return Ok(());
        }

        if bytes.len() % 4 != 0 {
            return Err(ValidationError {
                layer: Ipv4::name(),
                err_type: ValidationErrorType::InvalidValue,
                reason: "Ipv4 Options data length must be a multiple of 4",
            });
        }

        while let Some(option_type) = bytes.first() {
            match option_type {
                0 => break,
                1 => bytes = &bytes[1..],
                _ => match bytes.get(1) {
                    Some(0..=1) => return Err(ValidationError {
                        layer: Ipv4::name(),
                        err_type: ValidationErrorType::InvalidValue,
                        reason: "IPv4 option length field contained too small a value",
                    }),
                    Some(&len) => {
                        match bytes.get(len as usize..) {
                            Some(remaining) => bytes = remaining,
                            None => return Err(ValidationError {
                                layer: Ipv4::name(),
                                err_type: ValidationErrorType::InvalidValue,
                                reason: "truncated IPv4 option field in options--missing part of option data",
                            }),
                        }
                    }
                    None => return Err(ValidationError {
                        layer: Ipv4::name(),
                        err_type: ValidationErrorType::InvalidValue,
                        reason: "truncated IPv4 option found in options--missing option length field",
                    }),
                },
            }
        }

        Ok(())
    }

    #[inline]
    pub fn iter(&self) -> Ipv4OptionsIterRef<'a> {
        Ipv4OptionsIterRef {
            curr_idx: 0,
            bytes: self.bytes,
            end_reached: false,
        }
    }

    #[inline]
    pub fn padding(&self) -> &'a [u8] {
        let mut iter = self.iter();
        while iter.next().is_some() {}
        &iter.bytes[iter.curr_idx..]
    }
}

impl<'a> From<&'a Ipv4OptionsMut<'_>> for Ipv4OptionsRef<'a> {
    fn from(value: &'a Ipv4OptionsMut<'_>) -> Self {
        Self::from_bytes_unchecked(value.bytes)
    }
}

impl<'a> From<Ipv4OptionsMut<'a>> for Ipv4OptionsRef<'a> {
    fn from(value: Ipv4OptionsMut<'a>) -> Self {
        Self::from_bytes_unchecked(value.bytes)
    }
}

pub struct Ipv4OptionsIterRef<'a> {
    curr_idx: usize,
    bytes: &'a [u8],
    end_reached: bool,
}

impl<'a> Iterator for Ipv4OptionsIterRef<'a> {
    type Item = Ipv4OptionRef<'a>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.end_reached {
            return None;
        }

        match self.bytes.first() {
            Some(&r @ (0 | 1)) => {
                let option = &self.bytes[self.curr_idx..self.curr_idx + 1];
                self.curr_idx += 1;
                if r == 0 {
                    self.end_reached = true;
                }
                Some(Ipv4OptionRef::from_bytes_unchecked(option))
            }
            Some(&op_len) => {
                let option = &self.bytes[self.curr_idx..self.curr_idx + op_len as usize];
                self.curr_idx += op_len as usize;
                Some(Ipv4OptionRef::from_bytes_unchecked(option))
            }
            None => None,
        }
    }
}

#[derive(Debug)]
pub struct Ipv4OptionsMut<'a> {
    bytes: &'a mut [u8],
}

impl<'a> Ipv4OptionsMut<'a> {
    #[inline]
    pub fn from_bytes(bytes: &'a mut [u8]) -> Result<Self, ValidationError> {
        Self::validate(bytes)?;
        Ok(Self::from_bytes_unchecked(bytes))
    }

    #[inline]
    pub fn from_bytes_unchecked(bytes: &'a mut [u8]) -> Self {
        Ipv4OptionsMut { bytes }
    }

    #[inline]
    pub fn validate(bytes: &[u8]) -> Result<(), ValidationError> {
        Ipv4OptionsRef::validate(bytes)
    }

    #[inline]
    pub fn iter(&'a self) -> Ipv4OptionsIterRef<'a> {
        Ipv4OptionsIterRef {
            curr_idx: 0,
            bytes: self.bytes,
            end_reached: false,
        }
    }

    /*
    #[inline]
    pub fn iter_mut(&'a mut self) -> Ipv4OptionsIterMut<'a> {
        Ipv4OptionsIterMut {
            curr_idx: 0,
            bytes: self.bytes,
            end_reached: false,
        }
    }
    */

    #[inline]
    pub fn padding(&'a self) -> &'a [u8] {
        let mut iter = self.iter();
        while iter.next().is_some() {}
        &iter.bytes[iter.curr_idx..]
    }

    /*
    #[inline]
    pub fn padding_mut(&'a mut self) -> &'a mut [u8] {
        let mut iter = self.iter_mut();
        while iter.next().is_some() {}
        &mut iter.bytes[iter.curr_idx..]
    }
    */
}

/*
pub struct Ipv4OptionsIterMut<'a> {
    curr_idx: usize,
    bytes: &'a mut [u8],
    end_reached: bool,
}

impl<'a> Iterator for Ipv4OptionsIterMut<'a> {
    type Item = Ipv4OptionMut<'a>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.end_reached {
            return None;
        }

        match self.bytes[0] as usize {
            r @ (0 | 1) => {
                let option = &mut self.bytes[self.curr_idx..self.curr_idx + 1];
                self.curr_idx += 1;
                if r == 0 {
                    self.end_reached = true;
                }
                Some(Ipv4OptionMut::from_bytes_unchecked(option))
            }
            op_len => {
                let option = &mut self.bytes[self.curr_idx..self.curr_idx + op_len];
                self.curr_idx += op_len;
                Some(Ipv4OptionMut::from_bytes_unchecked(option))
            }
        }
    }
}
*/

/*
pub struct Ipv4OptionsBuilder<'a, const N: usize> {
    options: [(u8, &'a [u8]); N],
}

impl<'a, const N: usize> Ipv4OptionsBuilder<'a, N> {
    pub fn build<'b>(ipv4: &mut Ipv4Mut<'b>) -> Result<(), ()> {

    }
}
*/

// EOOL and NOP must have a size of 0
#[derive(Clone, Debug)]
pub struct Ipv4Option {
    option_type: u8,
    value: Option<Vec<u8>>,
}

impl Ipv4Option {
    #[inline]
    fn to_bytes_extended(&self, bytes: &mut Vec<u8>) {
        bytes.push(self.option_type);
        match self.option_type {
            0 | 1 => (),
            _ => match self.value.as_ref() {
                None => bytes.push(2),
                Some(val) => {
                    bytes.push((2 + val.len()) as u8);
                    bytes.extend(val);
                }
            },
        }
    }

    #[inline]
    fn to_bytes(&self) -> Vec<u8> {
        let mut v = Vec::new();
        self.to_bytes_extended(&mut v);
        v
    }
}

impl Ipv4Option {
    #[inline]
    pub fn from_bytes(bytes: &[u8]) -> Result<Self, ValidationError> {
        Self::validate(bytes)?;
        Ok(Self::from_bytes_unchecked(bytes))
    }

    #[inline]
    pub fn from_bytes_unchecked(bytes: &[u8]) -> Self {
        Self::from(Ipv4OptionRef::from_bytes_unchecked(bytes))
    }

    #[inline]
    pub fn validate(bytes: &[u8]) -> Result<(), ValidationError> {
        Ipv4OptionRef::validate(bytes)
    }

    #[inline]
    pub fn byte_len(&self) -> usize {
        match self.option_type {
            0 | 1 => 1,
            _ => 2 + self.value.as_ref().map(|v| v.len()).unwrap_or(0),
        }
    }

    #[inline]
    pub fn option_type(&self) -> u8 {
        self.option_type
    }

    #[inline]
    pub fn copied(&self) -> bool {
        self.option_type & 0x80 > 0
    }

    #[inline]
    pub fn option_class(&self) -> u8 {
        // SAFETY: this value can only ever be between 0 and 3 inclusive
        (self.option_type & 0x60) >> 5
    }

    #[inline]
    pub fn option_length(&self) -> usize {
        match self.option_type {
            0 | 1 => 1,
            _ => self.value.as_ref().unwrap().len() + 2,
        }
    }

    #[inline]
    pub fn option_data(&self) -> &[u8] {
        match &self.value {
            Some(v) => v.as_slice(),
            None => &[],
        }
    }
}

impl From<&Ipv4OptionRef<'_>> for Ipv4Option {
    #[inline]
    fn from(ipv4_option: &Ipv4OptionRef<'_>) -> Self {
        Ipv4Option {
            option_type: ipv4_option.option_type(),
            value: match ipv4_option.option_type() {
                0 | 1 => None,
                _ => Some(Vec::from(ipv4_option.option_data())),
            },
        }
    }
}

impl From<Ipv4OptionRef<'_>> for Ipv4Option {
    #[inline]
    fn from(ipv4_option: Ipv4OptionRef<'_>) -> Self {
        Self::from(&ipv4_option)
    }
}

pub struct Ipv4OptionRef<'a> {
    bytes: &'a [u8],
}

impl<'a> Ipv4OptionRef<'a> {
    #[inline]
    pub fn from_bytes(bytes: &'a [u8]) -> Result<Self, ValidationError> {
        Self::validate(bytes)?;
        Ok(Self::from_bytes_unchecked(bytes))
    }

    #[inline]
    pub fn from_bytes_unchecked(bytes: &'a [u8]) -> Self {
        Ipv4OptionRef { bytes }
    }

    #[inline]
    pub fn validate(bytes: &[u8]) -> Result<(), ValidationError> {
        match bytes.first() {
            Some(0 | 1) => if bytes.len() == 1 {
                Ok(())
            } else {
                Err(ValidationError {
                    layer: Ipv4::name(),
                    err_type: ValidationErrorType::ExcessBytes(bytes.len() - 1),
                    reason: "excess bytes at end of single-byte IPv4 option"
                })
            },
            Some(_) => match bytes.get(1) {
                Some(&len @ 2..) if bytes.len() >= len as usize => match bytes.len().checked_sub(len as usize) {
                    Some(0) => Ok(()),
                    Some(remaining) => Err(ValidationError {
                        layer: Ipv4::name(),
                        err_type: ValidationErrorType::ExcessBytes(remaining),
                        reason: "excess bytes at end of sized IPv4 option",
                    }),
                    None => Err(ValidationError {
                        layer: Ipv4::name(),
                        err_type: ValidationErrorType::InvalidValue,
                        reason: "length of IPv4 Option data exceeded available bytes"
                    }),
                },
                _ => Err(ValidationError {
                    layer: Ipv4::name(),
                    err_type: ValidationErrorType::InvalidValue,
                    reason: "insufficient bytes available to read IPv4 Option--missing length byte field"
                }),
            },
            None => Err(ValidationError {
                layer: Ipv4::name(),
                err_type: ValidationErrorType::InvalidValue,
                reason: "insufficient bytes available to read IPv4 Option--missing option_type byte field",
            })
        }
    }

    #[inline]
    pub fn option_len(&self) -> usize {
        self.bytes.len()
    }

    #[inline]
    pub fn option_type(&self) -> u8 {
        self.bytes[0]
    }

    #[inline]
    pub fn copied(&self) -> bool {
        self.bytes[0] & 0b_1000_0000 > 0
    }

    #[inline]
    pub fn option_class(&self) -> u8 {
        // SAFETY: this value can only ever be between 0 and 3 inclusive
        (self.bytes[0] & 0b_0110_0000) >> 5
    }

    #[inline]
    pub fn option_data(&self) -> &[u8] {
        match &self.bytes[0] {
            0 | 1 => &[],
            _ => &self.bytes[2..self.bytes[1] as usize],
        }
    }
}

impl<'a> From<&'a Ipv4OptionMut<'_>> for Ipv4OptionRef<'a> {
    fn from(value: &'a Ipv4OptionMut<'_>) -> Self {
        Ipv4OptionRef { bytes: value.bytes }
    }
}

impl<'a> From<Ipv4OptionMut<'a>> for Ipv4OptionRef<'a> {
    fn from(value: Ipv4OptionMut<'a>) -> Self {
        Ipv4OptionRef { bytes: value.bytes }
    }
}

pub struct Ipv4OptionMut<'a> {
    bytes: &'a mut [u8],
}

impl<'a> Ipv4OptionMut<'a> {
    #[inline]
    pub fn from_bytes(bytes: &'a mut [u8]) -> Result<Self, ValidationError> {
        Self::validate(bytes)?;
        Ok(Self::from_bytes_unchecked(bytes))
    }

    #[inline]
    pub fn from_bytes_unchecked(bytes: &'a mut [u8]) -> Self {
        Ipv4OptionMut { bytes }
    }

    #[inline]
    pub fn validate(bytes: &[u8]) -> Result<(), ValidationError> {
        Ipv4OptionRef::validate(bytes)
    }

    #[inline]
    pub fn option_len(&self) -> usize {
        self.bytes.len()
    }

    #[inline]
    pub fn option_type(&self) -> u8 {
        self.bytes[0]
    }

    #[inline]
    pub fn set_option_type(&mut self, option_type: u8) {
        self.bytes[0] = option_type;
    }

    #[inline]
    pub fn copied(&self) -> bool {
        self.bytes[0] & 0b_1000_0000 > 0
    }

    #[inline]
    pub fn option_class(&self) -> u8 {
        // SAFETY: this value can only ever be between 0 and 3 inclusive
        (self.bytes[0] & 0b_0110_0000) >> 5
    }

    #[inline]
    pub fn option_data(&self) -> &[u8] {
        match &self.bytes[0] {
            0 | 1 => &[],
            _ => &self.bytes[2..self.bytes[1] as usize],
        }
    }
}

// =============================================================================
//                                    IPv6
// =============================================================================

/// An IPv6 (Internet Protocol version 6) packet.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |Version| Traffic Class |              Flow Label               |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  4 |    Options & Payload Length   | Next Hdr Type |   Hop Limit   |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  8 |                         Source Address                        |
///    |                                                               |
///    |                                                               |
///    |                                                               |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 24 |                      Destination Address                      |
///    |                                                               |
///    |                                                               |
///    |                                                               |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 40 Z               Payload (or next Extension Header)              Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Clone, Debug, Layer, StatelessLayer)]
#[metadata_type(Ipv6Metadata)]
#[ref_type(Ipv6Ref)]
pub struct Ipv6 {
    // version, ihl, length, and next header type all calculated dynamically
    traffic_class: TrafficClass,
    flow_label: FlowLabel,
    hop_limit: u8,
    src: u128,
    dst: u128,
    payload: Option<Box<dyn LayerObject>>,
}

impl Ipv6 {
    /// The Traffic Class of the packet.
    #[inline]
    pub fn traffic_class(&self) -> TrafficClass {
        self.traffic_class
    }

    /// Sets the Traffic Class of the packet.
    #[inline]
    pub fn set_traffic_class(&mut self, class: TrafficClass) {
        self.traffic_class = class;
    }

    /// The Flow Label of the packet.
    #[inline]
    pub fn flow_label(&self) -> FlowLabel {
        self.flow_label
    }

    /// Sets the Flow Label of the packet.
    #[inline]
    pub fn set_flow_label(&mut self, label: FlowLabel) {
        self.flow_label = label;
    }

    /// The hop limit of the packet.
    ///
    /// Similar to [`Ipv4::ttl()`], this field indicates the number of routing hops the
    /// message should be permitted to traverse before being dropped.
    ///
    /// When a router receives an IPv6 packet, it checks the Hop Limit field of the packet.
    /// If the hop limit is 0, the router drops the packet and optionally sends an ICMP
    /// "Time Exceeded" packet back to the address that sent the packet; otherwise, it
    /// decrements the value of the hop limit by 1 and routes the packet to its next hop.
    ///
    /// the Hop Limit field is primarily used to avoid resource exhaustion in the event
    /// that a routing loop forms, though tools like `traceroute` also use its functionality
    /// to identify routing paths across a network.
    #[inline]
    pub fn hop_limit(&self) -> u8 {
        self.hop_limit
    }

    /// Sets the hop limit of the packet.
    ///
    /// For more information on the Hop Limit field, see the [`Ipv6::hop_limit()`] method.
    pub fn set_hop_limit(&mut self, hop_limit: u8) {
        self.hop_limit = hop_limit;
    }

    /// The combined length of the IPv6 extension headers and payload.
    #[inline]
    pub fn data_length(&self) -> Option<u16> {
        todo!()
    }

    /// The source IP address of the packet.
    #[inline]
    pub fn src(&self) -> u128 {
        self.src
    }

    /// Sets the source IP address of the packet.
    #[inline]
    pub fn set_src(&mut self, src: u128) {
        self.src = src;
    }

    /// Sets the destination IP address of the packet.
    #[inline]
    pub fn set_dst(&mut self, dst: u128) {
        self.dst = dst;
    }
}

impl FromBytesCurrent for Ipv6 {
    #[inline]
    fn from_bytes_current_layer_unchecked(bytes: &[u8]) -> Self {
        let ipv6 = Ipv6Ref::from_bytes_unchecked(bytes);
        Ipv6 {
            traffic_class: ipv6.traffic_class(),
            flow_label: ipv6.flow_label(),
            hop_limit: ipv6.hop_limit(),
            src: ipv6.src(),
            dst: ipv6.dst(),
            payload: None,
        }
    }

    #[inline]
    fn payload_from_bytes_unchecked_default(&mut self, bytes: &[u8]) {
        let ipv6 = Ipv6Ref::from_bytes_unchecked(bytes);
        if ipv6.payload_raw().is_empty() {
            self.payload = None;
        } else {
            self.payload = match ipv6.next_header() {
                DATA_PROTO_IPV6_NO_NXT => None,
                DATA_PROTO_TCP => Some(Box::new(Tcp::from_bytes_unchecked(ipv6.payload_raw()))),
                DATA_PROTO_UDP => Some(Box::new(Udp::from_bytes_unchecked(ipv6.payload_raw()))),
                DATA_PROTO_SCTP => Some(Box::new(Sctp::from_bytes_unchecked(ipv6.payload_raw()))),
                /* Add additional protocols here */
                _ => Some(Box::new(Raw::from_bytes_unchecked(ipv6.payload_raw()))),
            };
        }
    }
}

impl LayerLength for Ipv6 {
    /// The total length (in bytes) of the Ipv6 header and payload.
    fn len(&self) -> usize {
        40 + self.payload.as_ref().map_or(0, |p| p.len())
    }
}

impl LayerObject for Ipv6 {
    #[inline]
    fn can_set_payload_default(&self, payload: &dyn LayerObject) -> bool {
        payload
            .layer_metadata()
            .as_any()
            .downcast_ref::<&dyn Ipv6PayloadMetadata>()
            .is_some()
    }

    #[inline]
    fn get_payload_ref(&self) -> Option<&dyn LayerObject> {
        self.payload.as_deref()
    }

    #[inline]
    fn get_payload_mut(&mut self) -> Option<&mut dyn LayerObject> {
        self.payload.as_deref_mut()
    }

    #[inline]
    fn set_payload_unchecked(&mut self, payload: Box<dyn LayerObject>) {
        self.payload = Some(payload);
    }

    #[inline]
    fn has_payload(&self) -> bool {
        self.payload.is_some()
    }

    #[inline]
    fn remove_payload(&mut self) -> Box<dyn LayerObject> {
        let mut ret = None;
        core::mem::swap(&mut ret, &mut self.payload);
        self.payload = None;
        ret.expect("remove_payload() called on IPv6 layer when layer had no payload")
    }
}

impl ToBytes for Ipv6 {
    #[inline]
    fn to_bytes_chksummed(&self, bytes: &mut Vec<u8>, _prev: Option<(LayerId, usize)>) {
        let start = bytes.len();
        bytes.push(0b_0110_0000 | ((self.traffic_class.value & 0xF0) >> 4));
        bytes.push(
            ((self.traffic_class.value & 0x0F) << 4)
                | ((self.flow_label.value & 0x_00_0F_00_00) >> 16) as u8,
        );
        bytes.push(((self.flow_label.value & 0x_00_00_FF_00) >> 8) as u8);
        bytes.push((self.flow_label.value & 0x_00_00_00_FF) as u8);
        bytes.extend(
            u16::try_from(self.payload.as_ref().map_or(0, |p| p.len()))
                .unwrap_or(u16::MAX)
                .to_be_bytes(),
        );
        bytes.push(match self.payload.as_ref() {
            None => DATA_PROTO_IPV6_NO_NXT,
            Some(p) => p
                .layer_metadata()
                .as_any()
                .downcast_ref::<&dyn Ipv6PayloadMetadata>()
                .map(|m| m.ip_data_protocol())
                .expect("unknown payload protocol found in IPv6 packet"),
        });
        bytes.push(self.hop_limit);
        bytes.extend(self.src.to_be_bytes());
        bytes.extend(self.dst.to_be_bytes());
        if let Some(p) = self.payload.as_ref() {
            p.to_bytes_chksummed(bytes, Some((Self::layer_id(), start)));
        }
    }
}

/// An IPv6 (Internet Protocol version 6) packet.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |Version| Traffic Class |              Flow Label               |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  4 |    Options & Payload Length   | Next Hdr Type |   Hop Limit   |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  8 |                         Source Address                        |
///    |                                                               |
///    |                                                               |
///    |                                                               |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 24 |                      Destination Address                      |
///    |                                                               |
///    |                                                               |
///    |                                                               |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 40 Z               Payload (or next Extension Header)              Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Copy, Clone, Debug, LayerRef, StatelessLayer)]
#[owned_type(Ipv6)]
#[metadata_type(Ipv6Metadata)]
pub struct Ipv6Ref<'a> {
    #[data_field]
    data: &'a [u8],
}

impl<'a> Ipv6Ref<'a> {
    /// The Internet Protocol Version of the packet (should be equal to 6).
    #[inline]
    pub fn version(&self) -> u8 {
        self.data
            .first()
            .expect("insufficient bytes in IPv6 packet to retrieve IP Version field")
            >> 4
    }

    /// The Traffic Class of the packet.
    #[inline]
    pub fn traffic_class(&self) -> TrafficClass {
        TrafficClass {
            value: self
                .data
                .first()
                .expect("insufficient bytes in IPv6 packet to retrieve Traffic Class field")
                << 4 + self
                    .data
                    .get(2)
                    .expect("insufficient bytes in IPv6 packet to retrieve Traffic Class field")
                >> 4,
        }
    }

    /// The Flow Label of the packet.
    #[inline]
    pub fn flow_label(&self) -> FlowLabel {
        FlowLabel {
            value: match (self.data.get(2), self.data.get(3), self.data.get(4)) {
                (Some(&a), Some(&b), Some(&c)) => {
                    (((a & 0x0F) as u32) << 16) + ((b as u32) << 8) + c as u32
                }
                _ => panic!("insufficient bytes in IPv6 packet to retrieve Flow Label field"),
            },
        }
    }

    /// The combined length of the IPv6 extension headers and payload.
    #[inline]
    pub fn data_length(&self) -> u16 {
        u16::from_be_bytes(
            self.data
                .get(4..6)
                .expect("insufficient bytes in IPv6 packet to retrieve Data Length field")
                .try_into()
                .unwrap(),
        )
    }

    /// A single byte value indicating the next header type following the IPv6 header.
    ///
    /// If any IPv6 Extension Headers are present in the packet, the Next Header Type
    /// field will indicate the type of the first Extension Header. That option then
    /// contains a Next Header field that indicates the type of the next header after
    /// it, and so on; the final header in the IPv6 packet indicates the type of the payload.
    ///
    /// The `pkts` library treats each of these Extension Headers as a distinct [`Layer`] type.
    #[inline]
    pub fn next_header(&self) -> u8 {
        *self
            .data
            .get(6)
            .expect("insufficient bytes in IPv6 packet to retrieve Next Header Type field")
    }

    /// The hop limit of the packet.
    ///
    /// Similar to [`Ipv4::ttl()`], this field indicates the number of routing hops the
    /// message should be permitted to traverse before being dropped.
    ///
    /// When a router receives an IPv6 packet, it checks the Hop Limit field of the packet.
    /// If the hop limit is 0, the router drops the packet and optionally sends an ICMP
    /// "Time Exceeded" packet back to the address that sent the packet; otherwise, it
    /// decrements the value of the hop limit by 1 and routes the packet to its next hop.
    ///
    /// the Hop Limit field is primarily used to avoid resource exhaustion in the event
    /// that a routing loop forms, though tools like `traceroute` also use its functionality
    /// to identify routing paths across a network.
    pub fn hop_limit(&self) -> u8 {
        *self
            .data
            .get(7)
            .expect("insufficient bytes in IPv6 packet to retrieve Hop Limit field")
    }

    /// The source IP address of the packet.
    #[inline]
    pub fn src(&self) -> u128 {
        u128::from_be_bytes(
            self.data
                .get(8..24)
                .expect("insufficient bytes in IPv6 packet to retrieve Source IP Address field")
                .try_into()
                .unwrap(),
        )
    }

    /// The destination IP address of the packet.
    #[inline]
    pub fn dst(&self) -> u128 {
        u128::from_be_bytes(
            self.data
                .get(24..40)
                .expect(
                    "insufficient bytes in IPv6 packet to retrieve Destination IP Address field",
                )
                .try_into()
                .unwrap(),
        )
    }

    /// The payload of the packet, in raw bytes.
    pub fn payload_raw(&self) -> &[u8] {
        self.data
            .get(40..)
            .expect("insufficient bytes in IPv6 packet to retrieve payload bytes")
    }
}

impl<'a> FromBytesRef<'a> for Ipv6Ref<'a> {
    #[inline]
    fn from_bytes_unchecked(packet: &'a [u8]) -> Self {
        Ipv6Ref { data: packet }
    }
}

impl LayerOffset for Ipv6Ref<'_> {
    #[inline]
    fn payload_byte_index_default(bytes: &[u8], layer_type: LayerId) -> Option<usize> {
        let payload = bytes
            .get(40..)
            .expect("insufficient bytes in IPv6 packet to retrieve payload");

        match bytes.get(6).map(|b| *b) {
            Some(DATA_PROTO_TCP) => {
                if layer_type == Tcp::layer_id() {
                    Some(40)
                } else {
                    TcpRef::payload_byte_index_default(payload, layer_type)
                        .map(|offset| 40 + offset)
                }
            }
            Some(DATA_PROTO_UDP) => {
                if layer_type == Udp::layer_id() {
                    Some(40)
                } else {
                    UdpRef::payload_byte_index_default(payload, layer_type)
                        .map(|offset| 40 + offset)
                }
            }
            Some(DATA_PROTO_SCTP) => {
                if layer_type == Sctp::layer_id() {
                    Some(40)
                } else {
                    SctpRef::payload_byte_index_default(payload, layer_type)
                        .map(|offset| 40 + offset)
                }
            }
            _ => {
                if layer_type == Raw::layer_id() {
                    Some(40)
                } else {
                    None
                }
            }
        }
    }
}

impl Validate for Ipv6Ref<'_> {
    #[inline]
    fn validate_current_layer(curr_layer: &[u8]) -> Result<(), ValidationError> {
        let (version, data_len) =
            match (curr_layer.first(), curr_layer.get(4..6)) {
                (Some(&ver), Some(len_arr)) => (
                    ver,
                    u16::from_be_bytes(len_arr.try_into().unwrap()) as usize,
                ),
                _ => return Err(ValidationError {
                    layer: Ipv4::name(),
                    err_type: ValidationErrorType::InsufficientBytes,
                    reason:
                        "packet too short for Ipv6 frame--missing data Length field in Ipv6 header",
                }),
                // If the Version byte is missing, the Data Length field will be too--we just report that. QED.
            };

        if 40 + data_len > curr_layer.len() {
            return Err(ValidationError {
                layer: Ipv4::name(),
                err_type: ValidationErrorType::InsufficientBytes,
                reason: "total data length reported in Ipv6 header exceeded the available bytes",
            });
        }

        // Now that InvalidSize errors have been checked, we validate values
        if version != IP_VERSION_IPV6 {
            // Version number not 4 (required for Ipv4)
            return Err(ValidationError {
                layer: Ipv4::name(),
                err_type: ValidationErrorType::InvalidValue,
                reason: "version number of Ipv6 header was not equal to 0x04",
            });
        }

        // Lastly, validate for ExcessBytes
        if 40 + data_len < curr_layer.len() {
            Err(ValidationError {
                layer: Ipv4Ref::name(),
                err_type: ValidationErrorType::ExcessBytes(curr_layer.len() - (data_len + 40)),
                reason:
                    "invalid Data Length field in Ipv6 header--extra bytes remain at end of packet",
            })
        } else {
            Ok(())
        }
    }

    #[inline]
    fn validate_payload_default(curr_layer: &[u8]) -> Result<(), ValidationError> {
        let next_header_type =
            match curr_layer.get(6) {
                Some(&t) => t,
                None => return Err(ValidationError {
                    layer: Self::name(),
                    err_type: ValidationErrorType::InsufficientBytes,
                    reason:
                        "packet too short for Ipv6 frame--missing data Length field in Ipv6 header",
                }),
            };

        let next_layer = match curr_layer.get(40..) {
            Some(l) => l,
            None => return Err(ValidationError {
                layer: Self::name(),
                err_type: ValidationErrorType::InsufficientBytes,
                reason:
                    "packet too short for Ipv6 frame--insufficient bytes available for Ipv6 header",
            }),
        };

        match next_header_type {
            DATA_PROTO_TCP => TcpRef::validate(next_layer),
            DATA_PROTO_UDP => UdpRef::validate(next_layer),
            DATA_PROTO_SCTP => SctpRef::validate(next_layer),
            /* Add more Layer types here */
            _ => RawRef::validate(next_layer),
        }
    }
}

#[derive(Debug, LayerMut, StatelessLayer)]
#[owned_type(Ipv6)]
#[ref_type(Ipv6Ref)]
#[metadata_type(Ipv6Metadata)]
pub struct Ipv6Mut<'a> {
    #[data_field]
    data: &'a mut [u8],
    #[data_length_field]
    len: usize,
}

impl<'a> Ipv6Mut<'a> {
    /// The Internet Protocol Version of the packet (should be equal to 6).
    #[inline]
    pub fn version(&self) -> u8 {
        self.data
            .first()
            .expect("insufficient bytes in IPv6 packet to retrieve IP Version field")
            >> 4
    }

    /// Sets the Internet Protocol Version of the packet.
    #[inline]
    pub fn set_version_unchecked(&mut self, version: u8) {
        let first = self
            .data
            .first_mut()
            .expect("insufficient bytes in IPv6 packet to set IP Version field");
        *first = (*first & 0x0F) | (version << 4);
    }

    /// The Traffic Class of the packet.
    #[inline]
    pub fn traffic_class(&self) -> TrafficClass {
        TrafficClass {
            value: self
                .data
                .first()
                .expect("insufficient bytes in IPv6 packet to retrieve Traffic Class field")
                << 4 + self
                    .data
                    .get(2)
                    .expect("insufficient bytes in IPv6 packet to retrieve Traffic Class field")
                >> 4,
        }
    }

    /// Sets the Traffic Class of the packet.
    #[inline]
    pub fn set_traffic_class(&mut self, traffic_class: TrafficClass) {
        let first = self
            .data
            .first_mut()
            .expect("insufficient bytes in IPv6 packet to set Traffic Class field");
        *first = (*first & 0x0F) | (traffic_class.value << 4);
        let second = self
            .data
            .get_mut(2)
            .expect("insufficient bytes in IPv6 packet to set Traffic Class field");
        *second = (*second & 0xF0) | (traffic_class.value >> 4);
    }

    /// The Flow Label of the packet.
    #[inline]
    pub fn flow_label(&self) -> FlowLabel {
        FlowLabel {
            value: match (self.data.get(2), self.data.get(3), self.data.get(4)) {
                (Some(&a), Some(&b), Some(&c)) => {
                    (((a & 0x0F) as u32) << 16) + ((b as u32) << 8) + c as u32
                }
                _ => panic!("insufficient bytes in IPv6 packet to retrieve Flow Label field"),
            },
        }
    }

    /// Sets the Flow Label of the packet.
    #[inline]
    pub fn set_flow_label(&mut self, flow_label: FlowLabel) {
        let second = self
            .data
            .get_mut(2)
            .expect("insufficient bytes in IPv6 packet to set Flow Label field");
        *second = (*second & 0xF0) | ((flow_label.value >> 16) & 0x0F) as u8;
        let third = self
            .data
            .get_mut(3)
            .expect("insufficient bytes in IPv6 packet to set Flow Label field");
        *third = ((flow_label.value >> 8) & 0xFF) as u8;
        let fourth = self
            .data
            .get_mut(4)
            .expect("insufficient bytes in IPv6 packet to set Flow Label field");
        *fourth = (flow_label.value & 0xFF) as u8;
    }

    /// The combined length of the IPv6 extension headers and payload.
    #[inline]
    pub fn data_length(&self) -> u16 {
        u16::from_be_bytes(
            self.data
                .get(4..6)
                .expect("insufficient bytes in IPv6 packet to retrieve Data Length field")
                .try_into()
                .unwrap(),
        )
    }

    /// Sets the combined length of the IPv6 extension headers and payload.
    #[inline]
    pub fn set_data_length_unchecked(&mut self, data_length: u16) {
        let data_length_field: &mut [u8; 2] = self
            .data
            .get_mut(4..6)
            .expect("insufficient bytes in IPv6 packet to set Data Length field")
            .try_into()
            .unwrap();
        *data_length_field = data_length.to_be_bytes();
    }

    /// A single byte value indicating the next header type following the IPv6 header.
    ///
    /// If any IPv6 Extension Headers are present in the packet, the Next Header Type
    /// field will indicate the type of the first Extension Header. That option then
    /// contains a Next Header field that indicates the type of the next header after
    /// it, and so on; the final header in the IPv6 packet indicates the type of the payload.
    ///
    /// The `pkts` library treats each of these Extension Headers as a distinct [`Layer`] type.
    #[inline]
    pub fn next_header(&self) -> u8 {
        *self
            .data
            .get(6)
            .expect("insufficient bytes in IPv6 packet to retrieve Next Header Type field")
    }

    /// Sets the Next Header Type field of the packet.
    pub fn set_next_header_unchecked(&mut self, header: u8) {
        *self
            .data
            .get_mut(6)
            .expect("insufficient bytes in IPv6 packet to set Next Header Type field") = header;
    }

    /// The hop limit of the packet.
    ///
    /// Similar to [`Ipv4::ttl()`], this field indicates the number of routing hops the
    /// message should be permitted to traverse before being dropped.
    ///
    /// When a router receives an IPv6 packet, it checks the Hop Limit field of the packet.
    /// If the hop limit is 0, the router drops the packet and optionally sends an ICMP
    /// "Time Exceeded" packet back to the address that sent the packet; otherwise, it
    /// decrements the value of the hop limit by 1 and routes the packet to its next hop.
    ///
    /// the Hop Limit field is primarily used to avoid resource exhaustion in the event
    /// that a routing loop forms, though tools like `traceroute` also use its functionality
    /// to identify routing paths across a network.
    pub fn hop_limit(&self) -> u8 {
        *self
            .data
            .get(7)
            .expect("insufficient bytes in IPv6 packet to retrieve Hop Limit field")
    }

    /// Sets the hop limit of the packet.
    ///
    /// For more information on the hop limit, refer to the [`Ipv6Ref::hop_limit()`] method.
    pub fn set_hop_limit(&mut self, hop_limit: u8) {
        *self
            .data
            .get_mut(7)
            .expect("insufficient bytes in IPv6 packet to set Hop Limit field") = hop_limit;
    }

    /// The source IP address of the packet.
    #[inline]
    pub fn src(&self) -> u128 {
        u128::from_be_bytes(
            self.data
                .get(8..24)
                .expect("insufficient bytes in IPv6 packet to retrieve Source IP Address field")
                .try_into()
                .unwrap(),
        )
    }

    /// Sets the source IP address of the packet.
    #[inline]
    pub fn set_src(&mut self, src: u128) {
        let src_field: &mut [u8; 16] = self
            .data
            .get_mut(8..24)
            .expect("insufficient bytes in IPv6 packet to set Source IP Address field")
            .try_into()
            .unwrap();
        *src_field = src.to_be_bytes();
    }

    /// The destination IP address of the packet.
    #[inline]
    pub fn dst(&self) -> u128 {
        u128::from_be_bytes(
            self.data
                .get(24..40)
                .expect(
                    "insufficient bytes in IPv6 packet to retrieve Destination IP Address field",
                )
                .try_into()
                .unwrap(),
        )
    }

    /// Sets the destination IP address of the packet.
    #[inline]
    pub fn set_dst(&mut self, dst: u128) {
        let dst_field: &mut [u8; 16] = self
            .data
            .get_mut(8..24)
            .expect("insufficient bytes in IPv6 packet to set Destination IP Address field")
            .try_into()
            .unwrap();
        *dst_field = dst.to_be_bytes();
    }

    /// The payload of the packet, in raw bytes.
    pub fn payload_raw(&self) -> &[u8] {
        self.data
            .get(40..)
            .expect("insufficient bytes in IPv6 packet to retrieve payload bytes")
    }
}

impl<'a> From<&'a Ipv6Mut<'a>> for Ipv6Ref<'a> {
    #[inline]
    fn from(value: &'a Ipv6Mut<'a>) -> Self {
        Ipv6Ref {
            data: &value.data[..value.len],
        }
    }
}

impl<'a> FromBytesMut<'a> for Ipv6Mut<'a> {
    #[inline]
    fn from_bytes_trailing_unchecked(bytes: &'a mut [u8], length: usize) -> Self {
        Ipv6Mut {
            data: bytes,
            len: length,
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct TrafficClass {
    value: u8,
}

impl TrafficClass {
    /// The Differentiated Services Code Point ([`DiffServ`]) value of the traffic class.
    #[inline]
    pub fn dscp(&self) -> DiffServ {
        DiffServ::from(self.value)
    }

    /// Sets the Differentiated Services Code Point ([`DiffServ`]) value of the traffic class.
    #[inline]
    pub fn set_dscp(&mut self, dscp: DiffServ) {
        self.value &= 0b_0000_0011;
        self.value |= dscp.dscp() << 2;
    }

    /// The Explicit Congestion Notification ([`Ecn`]) value of the traffic class.
    #[inline]
    pub fn ecn(&self) -> Ecn {
        Ecn::from(self.value & 0b_0000_0011)
    }

    /// Sets the Explicit Congestion Notification ([`Ecn`]) value of the traffic class.
    #[inline]
    pub fn set_ecn(&mut self, ecn: Ecn) {
        self.value &= 0b_1111_1100;
        self.value |= ecn as u8 & 0b_0000_0011;
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct FlowLabel {
    value: u32,
}

impl FlowLabel {
    /// The 20-bit flow label value.
    #[inline]
    pub fn label(&self) -> u32 {
        self.value
    }

    /// Sets the 20-bit flow label value.
    #[inline]
    pub fn set_label(&mut self, label: u32) {
        *self = FlowLabel::from(label);
    }
}

impl From<u32> for FlowLabel {
    #[inline]
    fn from(value: u32) -> Self {
        FlowLabel {
            value: value & 0x_00_0F_FF_FF,
        }
    }
}

// TODO: duplicate to make DestinationOptionsExt
/// The Hop-By-Hop Options extension header.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |  Next Header  | Header Length |      Options and Padding      |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
///  4 |                                                               |
///    +                                                               +
///  8 Z                         (More Options)                        Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Clone, Debug)]
pub struct HopByHopOptionsExt {}

/// The Routing extension header.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |  Next Header  | Header Length |  Routing Type | Segments Left |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  4 |                       Type-Specific Data                      |
///    +                                                               +
///  8 Z                   (More Type-Specific Data)                   Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Clone, Debug)]
pub struct RoutingExt {
    routing_type: u8,
    segments_left: u8,
    data: Vec<u8>,
}

/// The Fragment extension header.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |  Next Header  |  Reserved (0) |     Fragment Offset     |Res|M|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  4 |                         Identification                        |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Clone, Debug)]
pub struct FragmentExt {
    frag_offset: u16,
    more_fragments: bool,
    identification: u32,
}

/// The Security Authentication Header IPSec field.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |  Next Header  | Payload Length|            Reserved           |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  4 |                   Security Parameters Index                   |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  8 |                        Sequence Number                        |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 12 Z                     Integrity Check Value                     Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Clone, Debug)]
pub struct AuthHeader {
    sec_params_idx: u32,
    seq: u32,
    integrity_val: Vec<u8>,
}

// NOTE: Encapsulating Security Payload is considered a Layer of its own.
// This is because it contains payload data, and its Next Header indicates
// the type of layer contained in that payload. There are no layers following
// the Encapsulating Security Payload.

/*
/// The Encapsulating Security Payload IPSec field.
///
/// ## Packet Layout
/// ```txt
///    .    Octet 0    .    Octet 1    .    Octet 2    .    Octet 3    .
///    |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  0 |                   Security Parameters Index                   |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  4 |                        Sequence Number                        |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
///  8 |                          Payload Data                         |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 12 |                          Payload Data                         |
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// 16 Z                     Integrity Check Value                     Z
///    Z                                                               Z
/// .. .                              ...                              .
///    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
pub struct EncapsulatingSecPayload {

}
*/