qubit-metadata 0.4.5

Type-safe extensible metadata model for the Qubit LLM SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! [`MetadataField`] — one field definition in a metadata schema.

use qubit_datatype::DataType;
use serde::{
    Deserialize,
    Serialize,
};

/// Definition of one metadata field in a [`crate::MetadataSchema`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MetadataField {
    /// Runtime data type of this field.
    data_type: DataType,
    /// Whether this field must be present when validating metadata.
    required: bool,
}

impl MetadataField {
    /// Creates a field definition.
    #[inline]
    #[must_use]
    pub fn new(data_type: DataType, required: bool) -> Self {
        Self {
            data_type,
            required,
        }
    }

    /// Returns the runtime data type of this field.
    #[inline]
    #[must_use]
    pub fn data_type(&self) -> DataType {
        self.data_type
    }

    /// Returns `true` when this field is required.
    #[inline]
    #[must_use]
    pub fn is_required(&self) -> bool {
        self.required
    }
}