Skip to main content

compose_lens/model/
annotation.rs

1//! Source-aware service annotation declarations.
2
3use crate::source::SourceSpan;
4
5use super::{ComposeScalar, KeyValueEntry, Located};
6
7/// The exact authored mapping or list form of service `annotations`.
8#[derive(Debug, Clone, PartialEq, Eq)]
9#[non_exhaustive]
10pub enum AnnotationsForm {
11    /// Ordered mapping syntax with scalar kinds and spelling retained.
12    Map(Vec<KeyValueEntry>),
13    /// Ordered raw scalar list items, including invalid scalar kinds retained for diagnostics.
14    List(Vec<Located<ComposeScalar>>),
15}
16
17/// An explicitly authored service-level Compose `annotations` value.
18#[derive(Debug, Clone, PartialEq, Eq)]
19pub struct Annotations {
20    span: SourceSpan,
21    form: AnnotationsForm,
22}
23
24impl Annotations {
25    pub(crate) const fn new(span: SourceSpan, form: AnnotationsForm) -> Self {
26        Self { span, form }
27    }
28
29    /// Returns the exact span of the complete authored collection.
30    #[must_use]
31    pub const fn span(&self) -> SourceSpan {
32        self.span
33    }
34
35    /// Returns the authored mapping or list form without semantic normalization.
36    #[must_use]
37    pub const fn form(&self) -> &AnnotationsForm {
38        &self.form
39    }
40}