aldrin-core 0.13.0

Shared core components of Aldrin, a message bus for service-oriented RPC and interprocess communication.
Documentation
mod array_type;
mod built_in_type;
mod enum_fallback;
mod enum_ty;
mod event;
mod event_fallback;
mod field;
mod function;
mod function_fallback;
mod layout;
mod lexical_id;
mod map_type;
mod newtype;
mod result_type;
mod service;
mod struct_fallback;
mod struct_ty;
#[cfg(test)]
mod test;
mod type_id;
mod variant;

pub mod ir;
#[doc(hidden)]
pub mod private;

use crate::tags::{self, PrimaryTag, Tag};
use crate::{
    Deserialize, DeserializeError, Deserializer, Serialize, SerializeError, Serializer, TypeId,
};
use num_enum::{IntoPrimitive, TryFromPrimitive};
use std::collections::{BTreeMap, HashSet};

pub use array_type::ArrayType;
pub use built_in_type::BuiltInType;
pub use enum_fallback::EnumFallback;
pub use enum_ty::Enum;
pub use event::Event;
pub use event_fallback::EventFallback;
pub use field::Field;
pub use function::Function;
pub use function_fallback::FunctionFallback;
pub use layout::Layout;
pub use lexical_id::LexicalId;
pub use map_type::MapType;
pub use newtype::Newtype;
pub use result_type::ResultType;
pub use service::Service;
pub use struct_fallback::StructFallback;
pub use struct_ty::Struct;
pub use variant::Variant;

pub const VERSION: u32 = 2;

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(
    feature = "serde",
    derive(serde::Serialize, serde::Deserialize),
    serde(rename_all = "kebab-case")
)]
pub struct Introspection {
    type_id: TypeId,
    layout: Layout,

    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "HashSet::is_empty")
    )]
    references: HashSet<TypeId>,
}

impl Introspection {
    pub fn new<T: Introspectable + ?Sized>() -> Self {
        Self::from_dyn(DynIntrospectable::new::<T>())
    }

    pub fn from_dyn(ty: DynIntrospectable) -> Self {
        let introspection = ir::IntrospectionIr::from_dyn(ty);
        Self::from_ir(introspection)
    }

    pub fn from_ir(introspection: ir::IntrospectionIr) -> Self {
        let layout = Layout::from_ir(introspection.layout, &introspection.references);
        let references = introspection.references.into_values().collect();

        Self {
            type_id: introspection.type_id,
            layout,
            references,
        }
    }

    pub fn type_id(&self) -> TypeId {
        self.type_id
    }

    pub fn layout(&self) -> &Layout {
        &self.layout
    }

    pub fn references(&self) -> &HashSet<TypeId> {
        &self.references
    }

    pub fn iter_references(&self) -> impl ExactSizeIterator<Item = TypeId> + '_ {
        self.references.iter().copied()
    }

    pub fn as_built_in_layout(&self) -> Option<BuiltInType> {
        self.layout.as_built_in()
    }

    pub fn as_struct_layout(&self) -> Option<&Struct> {
        self.layout.as_struct()
    }

    pub fn as_enum_layout(&self) -> Option<&Enum> {
        self.layout.as_enum()
    }

    pub fn as_service_layout(&self) -> Option<&Service> {
        self.layout.as_service()
    }

    pub fn as_newtype_layout(&self) -> Option<&Newtype> {
        self.layout.as_newtype()
    }
}

impl From<ir::IntrospectionIr> for Introspection {
    fn from(introspection: ir::IntrospectionIr) -> Self {
        Self::from_ir(introspection)
    }
}

#[derive(IntoPrimitive, TryFromPrimitive)]
#[repr(u32)]
enum IntrospectionField {
    Version = 0,
    TypeId = 1,
    Layout = 2,
    References = 3,
}

impl Tag for Introspection {}

impl PrimaryTag for Introspection {
    type Tag = Self;
}

impl Serialize<Self> for Introspection {
    fn serialize(self, serializer: Serializer) -> Result<(), SerializeError> {
        serializer.serialize(&self)
    }
}

impl Serialize<Introspection> for &Introspection {
    fn serialize(self, serializer: Serializer) -> Result<(), SerializeError> {
        let mut serializer = serializer.serialize_struct1(4)?;

        serializer.serialize::<tags::U32>(IntrospectionField::Version, VERSION)?;
        serializer.serialize::<TypeId>(IntrospectionField::TypeId, self.type_id)?;
        serializer.serialize::<Layout>(IntrospectionField::Layout, &self.layout)?;

        serializer
            .serialize::<tags::Set<TypeId>>(IntrospectionField::References, &self.references)?;

        serializer.finish()
    }
}

impl Deserialize<Self> for Introspection {
    fn deserialize(deserializer: Deserializer) -> Result<Self, DeserializeError> {
        let mut deserializer = deserializer.deserialize_struct()?;

        let mut type_id = None;
        let mut layout = None;
        let mut references = None;

        while let Some(deserializer) = deserializer.deserialize()? {
            match deserializer.try_id() {
                Ok(IntrospectionField::Version) => {
                    if deserializer.deserialize::<tags::U32, u32>()? != VERSION {
                        return Err(DeserializeError::InvalidSerialization);
                    }
                }

                Ok(IntrospectionField::TypeId) => {
                    type_id = deserializer.deserialize::<TypeId, _>().map(Some)?;
                }

                Ok(IntrospectionField::Layout) => {
                    layout = deserializer.deserialize::<Layout, _>().map(Some)?;
                }

                Ok(IntrospectionField::References) => {
                    references = deserializer
                        .deserialize::<tags::Set<TypeId>, _>()
                        .map(Some)?;
                }

                Err(_) => deserializer.skip()?,
            }
        }

        deserializer.finish(Self {
            type_id: type_id.ok_or(DeserializeError::InvalidSerialization)?,
            layout: layout.ok_or(DeserializeError::InvalidSerialization)?,
            references: references.ok_or(DeserializeError::InvalidSerialization)?,
        })
    }
}

#[derive(Debug)]
pub struct References<'a> {
    inner: &'a mut Vec<DynIntrospectable>,
}

impl<'a> References<'a> {
    pub fn new(inner: &'a mut Vec<DynIntrospectable>) -> Self {
        Self { inner }
    }

    pub fn add<T: Introspectable + ?Sized>(&mut self) {
        self.add_dyn(DynIntrospectable::new::<T>());
    }

    pub fn add_dyn(&mut self, ty: DynIntrospectable) {
        self.inner.push(ty);
    }

    pub fn reserve(&mut self, additional: usize) {
        self.inner.reserve(additional);
    }
}

impl Extend<DynIntrospectable> for References<'_> {
    fn extend<T>(&mut self, iter: T)
    where
        T: IntoIterator<Item = DynIntrospectable>,
    {
        self.inner.extend(iter);
    }
}

pub trait Introspectable {
    fn layout() -> ir::LayoutIr;
    fn lexical_id() -> LexicalId;
    fn add_references(references: &mut References);
}

#[derive(Debug, Copy, Clone)]
pub struct DynIntrospectable {
    layout: fn() -> ir::LayoutIr,
    lexical_id: fn() -> LexicalId,
    add_references: fn(&mut References),
}

impl DynIntrospectable {
    pub fn new<T: Introspectable + ?Sized>() -> Self {
        Self {
            layout: T::layout,
            lexical_id: T::lexical_id,
            add_references: T::add_references,
        }
    }

    pub fn layout(self) -> ir::LayoutIr {
        (self.layout)()
    }

    pub fn lexical_id(self) -> LexicalId {
        (self.lexical_id)()
    }

    pub fn add_references(self, references: &mut References) {
        (self.add_references)(references)
    }
}

#[track_caller]
fn resolve_ir(lexical_id: LexicalId, references: &BTreeMap<LexicalId, TypeId>) -> TypeId {
    references
        .get(&lexical_id)
        .copied()
        .expect("incomplete introspection references")
}