Skip to main content

LayoutSnapshot

Struct LayoutSnapshot 

Source
pub struct LayoutSnapshot { /* private fields */ }
Expand description

Serializable snapshot of a LayoutRuntime for session persistence.

Strategy runtimes serialize the recipe (strategy config + panel kinds). Non-strategy runtimes serialize the tree topology.

§Example

let mut rt = Layout::master_stack(["editor", "chat", "status"])
    .master_ratio(0.6).gap(1.0).into_runtime().unwrap();
let snapshot = rt.snapshot().unwrap();

// Serialize with any serde format:
// let json = serde_json::to_string(&snapshot).unwrap();

// Restore later:
let mut rt2 = panes::runtime::LayoutRuntime::from_snapshot(snapshot).unwrap();

Implementations§

Source§

impl LayoutSnapshot

Source

pub fn source(&self) -> &SnapshotSource

Returns the snapshot source: a strategy config, tree topology, or adaptive breakpoint set.

Source

pub fn focused(&self) -> Option<&str>

Returns the kind of the focused panel at capture time, if any.

Source

pub fn collapsed(&self) -> &[Box<str>]

Returns the kinds of all collapsed panels at capture time.

Source

pub fn focused_key(&self) -> Option<PanelKey>

Sequence index of the focused panel for deterministic restore.

Source

pub fn collapsed_keys(&self) -> &[PanelKey]

Sequence indices of collapsed panels for deterministic restore.

Source

pub fn overlays(&self) -> &[SnapshotOverlay]

Returns the overlay definitions captured at snapshot time.

Source

pub fn into_overlays(self) -> Vec<SnapshotOverlay>

Consumes the snapshot and returns the overlay definitions as an owned Vec.

Trait Implementations§

Source§

impl Clone for LayoutSnapshot

Source§

fn clone(&self) -> LayoutSnapshot

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LayoutSnapshot

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.