facet-format 0.47.0

Core Serializer/Deserializer traits for facet
Documentation
extern crate alloc;

use alloc::borrow::Cow;
use alloc::sync::Arc;
use core::fmt;
use facet_core::Shape;

use facet_solver::{KeyResult, Resolution, ResolutionHandle, Schema, Solver};

use crate::{FormatParser, ParseError, ParseEventKind};

/// High-level outcome from solving an untagged enum.
pub struct SolveOutcome {
    /// The schema that was used for solving
    pub schema: Arc<Schema>,
    /// Index of the chosen resolution in `schema.resolutions()`
    pub resolution_index: usize,
}

/// Error when variant solving fails.
#[derive(Debug)]
pub enum SolveVariantError {
    /// No variant matched the evidence.
    NoMatch,
    /// Parser error while reading events.
    Parser(ParseError),
    /// Schema construction error.
    SchemaError(facet_solver::SchemaError),
}

impl SolveVariantError {
    /// Wrap a parse error into [`SolveVariantError::Parser`].
    pub const fn from_parser(e: ParseError) -> Self {
        Self::Parser(e)
    }
}

impl fmt::Display for SolveVariantError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::NoMatch => write!(f, "No variant matched"),
            Self::Parser(e) => write!(f, "Parser error: {}", e),
            Self::SchemaError(e) => write!(f, "Schema error: {}", e),
        }
    }
}

impl core::error::Error for SolveVariantError {}

/// Attempt to solve which enum variant matches the input.
///
/// This uses save/restore to read ahead and determine the variant without
/// consuming the events permanently. After this returns, the parser position
/// is restored so the actual deserialization can proceed.
///
/// Returns `Ok(Some(_))` if a unique variant was found, `Ok(None)` if
/// no variant matched, or `Err(_)` on error.
pub fn solve_variant<'de>(
    shape: &'static Shape,
    parser: &mut dyn FormatParser<'de>,
) -> Result<Option<SolveOutcome>, SolveVariantError> {
    let schema = Arc::new(Schema::build_auto(shape)?);
    let mut solver = Solver::new(&schema);

    // Save position and start recording events
    let save_point = parser.save();

    let mut depth = 0i32;
    let mut in_struct = false;
    let mut expecting_value = false;

    let result = loop {
        let event = parser
            .next_event()
            .map_err(SolveVariantError::from_parser)?;

        let Some(event) = event else {
            // EOF reached
            return Ok(None);
        };

        match event.kind {
            ParseEventKind::StructStart(_) => {
                depth += 1;
                if depth == 1 {
                    in_struct = true;
                }
            }
            ParseEventKind::StructEnd => {
                depth -= 1;
                if depth == 0 {
                    // Done with top-level struct
                    break None;
                }
            }
            ParseEventKind::SequenceStart(_) => {
                depth += 1;
            }
            ParseEventKind::SequenceEnd => {
                depth -= 1;
            }
            ParseEventKind::FieldKey(key) => {
                if depth == 1 && in_struct {
                    // Top-level field - feed to solver
                    if let Some(name) = key.name().cloned()
                        && let Some(handle) = handle_key(&mut solver, name)
                    {
                        break Some(handle);
                    }
                    expecting_value = true;
                }
            }
            ParseEventKind::Scalar(_)
            | ParseEventKind::OrderedField
            | ParseEventKind::VariantTag(_) => {
                if expecting_value {
                    expecting_value = false;
                }
            }
        }
    };

    // Restore position regardless of outcome
    parser.restore(save_point);

    match result {
        Some(handle) => {
            let idx = handle.index();
            Ok(Some(SolveOutcome {
                schema,
                resolution_index: idx,
            }))
        }
        None => Ok(None),
    }
}

fn handle_key<'a>(solver: &mut Solver<'a>, name: Cow<'a, str>) -> Option<ResolutionHandle<'a>> {
    match solver.see_key(name) {
        KeyResult::Solved(handle) => Some(handle),
        KeyResult::Unknown | KeyResult::Unambiguous { .. } | KeyResult::Ambiguous { .. } => None,
    }
}

impl From<facet_solver::SchemaError> for SolveVariantError {
    fn from(e: facet_solver::SchemaError) -> Self {
        Self::SchemaError(e)
    }
}

impl SolveOutcome {
    /// Resolve the selected configuration reference.
    pub fn resolution(&self) -> &Resolution {
        &self.schema.resolutions()[self.resolution_index]
    }
}