From 44fe2d678a15ffcb4c8dc2e3fea26c5d6057c7c4 Mon Sep 17 00:00:00 2001
From: Zak Cutner <zak@cloudflare.com>
Date: Tue, 12 Nov 2024 16:58:02 -0500
Subject: [PATCH] Expose `CompoundType` publicly

This is needed to be able to construct more advanced types, such as
arrays and maps, using the public API.

Also make the `CompoundType::from_type` function publicly so it is
possible to construct compound types in public functions using the
public API.
---
 engine/src/lhs_types/array.rs |  9 +--------
 engine/src/lib.rs             |  4 ++--
 engine/src/types.rs           | 16 +++++++++++-----
 3 files changed, 14 insertions(+), 15 deletions(-)

diff --git a/engine/src/lhs_types/array.rs b/engine/src/lhs_types/array.rs
index c0a0cad6..6d47c542 100644
--- a/engine/src/lhs_types/array.rs
+++ b/engine/src/lhs_types/array.rs
@@ -581,15 +581,8 @@ impl<'a, V: IntoValue<'a>> FromIterator<V> for TypedArray<'a, V> {
     }
 }
 
-const fn compound_from_type(ty: Type) -> CompoundType {
-    match CompoundType::from_type(ty) {
-        Some(ty) => ty,
-        None => panic!("Could not convert type to compound type"),
-    }
-}
-
 impl<'a, V: IntoValue<'a>> IntoValue<'a> for TypedArray<'a, V> {
-    const TYPE: Type = Type::Array(compound_from_type(V::TYPE));
+    const TYPE: Type = Type::Array(CompoundType::from_type(V::TYPE));
 
     #[inline]
     fn into_value(self) -> LhsValue<'a> {
diff --git a/engine/src/lib.rs b/engine/src/lib.rs
index ea98accb..4ec97ebe 100644
--- a/engine/src/lib.rs
+++ b/engine/src/lib.rs
@@ -120,7 +120,7 @@ pub use self::{
         UnknownFieldError,
     },
     types::{
-        ExpectedType, ExpectedTypeList, GetType, LhsValue, LhsValueMut, RhsValue, RhsValues, Type,
-        TypeMismatchError,
+        CompoundType, ExpectedType, ExpectedTypeList, GetType, LhsValue, LhsValueMut, RhsValue,
+        RhsValues, Type, TypeMismatchError,
     },
 };
diff --git a/engine/src/types.rs b/engine/src/types.rs
index 42fdfbf2..7b5277a1 100644
--- a/engine/src/types.rs
+++ b/engine/src/types.rs
@@ -41,11 +41,11 @@ pub enum ExpectedType {
     /// Fully identified expected type
     Type(Type),
     /// Loosely identified array type
-    /// Usefull when expecting an array without
+    /// Useful when expecting an array without
     /// knowing of which specific value type
     Array,
     /// Loosely identified map type
-    /// Usefull when expecting a map without
+    /// Useful when expecting a map without
     /// knowing of which specific value type
     Map,
 }
@@ -986,6 +986,8 @@ enum Layer {
     Map,
 }
 
+/// A types for field values that can be nested within another type such as an
+/// array or map.
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct CompoundType {
     layers: u32,
@@ -1023,15 +1025,19 @@ impl CompoundType {
         }
     }
 
+    /// Converts a [`Type`] into [`CompoundType`].
     #[inline]
-    pub(crate) const fn from_type(ty: Type) -> Option<Self> {
-        match ty {
+    pub const fn from_type(ty: Type) -> Self {
+        match match ty {
             Type::Bool => Some(Self::new(PrimitiveType::Bool)),
             Type::Bytes => Some(Self::new(PrimitiveType::Bytes)),
             Type::Int => Some(Self::new(PrimitiveType::Int)),
             Type::Ip => Some(Self::new(PrimitiveType::Ip)),
             Type::Array(ty) => ty.push(Layer::Array),
             Type::Map(ty) => ty.push(Layer::Map),
+        } {
+            Some(ty) => ty,
+            None => panic!("Could not convert type to compound type"),
         }
     }
 
@@ -1078,7 +1084,7 @@ impl From<PrimitiveType> for CompoundType {
 impl From<Type> for CompoundType {
     #[inline]
     fn from(ty: Type) -> Self {
-        Self::from_type(ty).unwrap()
+        Self::from_type(ty)
     }
 }