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

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