ratatui_toolkit/primitives/split_layout/pane_layout/methods/
area.rs

1use ratatui::layout::Rect;
2
3use crate::primitives::split_layout::pane_layout::PaneLayout;
4
5impl PaneLayout {
6    /// Returns the rectangle allocated to this pane.
7    ///
8    /// # Arguments
9    /// - None.
10    ///
11    /// # Returns
12    /// The allocated `Rect`.
13    ///
14    /// # Errors
15    /// - None.
16    ///
17    /// # Panics
18    /// - Does not panic.
19    ///
20    /// # Safety
21    /// - No safety requirements.
22    ///
23    /// # Performance
24    /// - O(1).
25    ///
26    /// # Example
27    /// ```rust
28    /// use ratatui::layout::Rect;
29    /// use ratatui_toolkit::primitives::split_layout::SplitLayout;
30    ///
31    /// let layout = SplitLayout::new(0);
32    /// let panes = layout.layout_panes(Rect::new(0, 0, 10, 5));
33    /// let _ = panes[0].area();
34    /// ```
35    pub fn area(&self) -> Rect {
36        self.area
37    }
38}