vortex_layout/
session.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use std::any::Any;
5
6use vortex_session::ArcSwapMap;
7use vortex_session::SessionExt;
8use vortex_session::SessionGuard;
9use vortex_session::SessionVar;
10use vortex_session::registry::Id;
11
12use crate::LayoutEncoding;
13use crate::LayoutEncodingRef;
14use crate::layouts::chunked::Chunked;
15use crate::layouts::dict::Dict;
16use crate::layouts::flat::Flat;
17use crate::layouts::list::List;
18use crate::layouts::struct_::Struct;
19use crate::layouts::zoned::LegacyStats;
20use crate::layouts::zoned::Zoned;
21
22/// Registry of layout encodings.
23pub type LayoutRegistry = ArcSwapMap<Id, LayoutEncodingRef>;
24
25/// Session state for layout encodings.
26#[derive(Clone, Debug)]
27pub struct LayoutSession {
28    registry: LayoutRegistry,
29}
30
31impl LayoutSession {
32    /// Register a layout encoding in the session, replacing any existing encoding with the same ID.
33    pub fn register(&self, layout_ref: impl Into<LayoutEncodingRef>) {
34        let layout = layout_ref.into();
35        self.registry.insert(layout.id(), layout);
36    }
37
38    /// Register layout encodings in the session, replacing any existing encodings with the same IDs.
39    pub fn register_many(&self, layouts: impl IntoIterator<Item = LayoutEncodingRef>) {
40        for layout in layouts {
41            self.registry.insert(layout.id(), layout);
42        }
43    }
44
45    /// Returns the layout encoding registry.
46    pub fn registry(&self) -> &LayoutRegistry {
47        &self.registry
48    }
49}
50
51impl Default for LayoutSession {
52    fn default() -> Self {
53        let this = Self {
54            registry: LayoutRegistry::default(),
55        };
56
57        // Register the built-in layout encodings.
58        this.register(&Chunked as &dyn LayoutEncoding);
59        this.register(&Flat as &dyn LayoutEncoding);
60        this.register(&Struct as &dyn LayoutEncoding);
61        this.register(&Zoned as &dyn LayoutEncoding);
62        this.register(&LegacyStats as &dyn LayoutEncoding);
63        this.register(&Dict as &dyn LayoutEncoding);
64        this.register(&List as &dyn LayoutEncoding);
65        this
66    }
67}
68
69impl SessionVar for LayoutSession {
70    fn as_any(&self) -> &dyn Any {
71        self
72    }
73    fn as_any_mut(&mut self) -> &mut dyn Any {
74        self
75    }
76}
77
78/// Extension trait for accessing layout session data.
79pub trait LayoutSessionExt: SessionExt {
80    /// Returns the layout encoding registry.
81    fn layouts(&self) -> SessionGuard<'_, LayoutSession> {
82        self.get::<LayoutSession>()
83    }
84}
85impl<S: SessionExt> LayoutSessionExt for S {}
vortex_layout/session.rs

vortex_layout/
session.rs
