qubit-metadata 0.7.1

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Strict v1 wire envelope for [`crate::MetadataSchema`].

use std::marker::PhantomData;

use serde::Deserialize;
use serde::Deserializer;
use serde::Serialize;
use serde::de::DeserializeSeed;

use super::MetadataSchemaWireV1Seed;
use crate::UnknownFilterFieldPolicy;
use crate::UnknownMetadataFieldPolicy;

/// Current serialized metadata-schema format version.
pub(crate) const METADATA_SCHEMA_WIRE_VERSION_V1: u8 = 1;

/// Strict schema envelope with a generic borrowed or owned field map.
///
/// # Type Parameters
///
/// * `F` - Borrowed or owned map of metadata field definitions.
#[derive(Serialize)]
#[serde(deny_unknown_fields)]
pub(crate) struct MetadataSchemaWireV1<F> {
    /// Wire-format version.
    pub(crate) version: u8,
    /// Borrowed or owned metadata field definitions.
    pub(crate) fields: F,
    /// Policy for metadata keys absent from the schema.
    pub(crate) unknown_metadata_field_policy: UnknownMetadataFieldPolicy,
    /// Policy for filter keys absent from the schema.
    pub(crate) unknown_filter_field_policy: UnknownFilterFieldPolicy,
}

impl<'de, F> Deserialize<'de> for MetadataSchemaWireV1<F>
where
    F: Deserialize<'de>,
{
    /// Deserializes the strict envelope through its map-only seed.
    ///
    /// # Type Parameters
    ///
    /// * `D` - Deserializer providing the schema envelope.
    ///
    /// # Parameters
    ///
    /// * `deserializer` - Source of the serialized schema envelope.
    ///
    /// # Returns
    ///
    /// The decoded envelope, with fields deserialized as `F`.
    ///
    /// # Errors
    ///
    /// Returns the deserializer error for positional input, duplicate,
    /// missing, or unknown fields, or a rejected field value.
    #[inline]
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        MetadataSchemaWireV1Seed::new(PhantomData::<F>).deserialize(deserializer)
    }
}