Struct State 

pub struct State { /* private fields */ }

Available on crate feature split-pane only.

The start view’s share of the space and the two panels’ limits.

Implementations

impl State

pub fn new(ratio: f32) -> Self

A split with the start view taking ratio of the space, from 0.0 to 1.0. Out of range ratios are clamped.

pub fn with_panels(start: Panel, end: Panel) -> Self

A split from two panels, for limits or collapsing beyond what State::min and State::collapsible set.

pub fn min(self, start: Extent, end: Extent) -> Self

The smallest each view may get.

pub fn max(self, start: Extent, end: Extent) -> Self

The largest each view may get.

pub fn collapsible(self, start: bool, end: bool) -> Self

Lets the start view, the end view or both snap shut when dragged below their threshold.

pub fn with_ratio(self, ratio: f32) -> Self

Starts from a saved ratio, as returned by State::ratio.

pub fn set_ratio(&mut self, ratio: f32)

Moves the handle so the start view takes ratio of the space, within both views’ limits once the split has been measured.

pub fn ratio(&self) -> f32

The start view’s share of the space, from 0.0 to 1.0.

pub fn is_start_collapsed(&self) -> bool

pub fn is_end_collapsed(&self) -> bool

pub fn group(&self) -> &State

The panel group underneath, for anything the ratio does not cover.

pub fn update(&mut self, event: Event) -> Option<Output>

Applies an event from the view or a keyboard action.

Trait Implementations

impl Clone for State

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

An even split.

impl PartialEq for State

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for State