Enum Split

pub enum Split {
    Horizontal,
    Vertical,
    Grid,
    Fibonacci,
    Dwindle,
}

Describes different ways a crate::geometry::Rect can be split.

Disclaimer: As it may be confusing - The terms vertical/horizontal are referring to the “splits” not the orientation of the resulting stack. For example, Split::Horizontal splits a rect by horizontal cuts, resulting in a “vertically stacked” list of rects. See the variants’ documentation for clarification.

Variants

Horizontal

Rectangle is split by horizontal cuts.

+--------+      +--------+
|        |      |        |
|        |      +--------+
|        |  =>  |        |
|        |      +--------+
|        |      |        |
+--------+      +--------+

Vertical

Rectangle is split by vertical cuts.

+--------+      +--+--+--+
|        |      |  |  |  |
|        |      |  |  |  |
|        |  =>  |  |  |  |
|        |      |  |  |  |
|        |      |  |  |  |
+--------+      +--+--+--+

Grid

Rectangle is split in a “Grid” pattern while still accounting for all of the available space, resulting in some rectangles being larger.

+-------+      +---+---+
|       |      |   |   |
|       |      |   |   |
|       |  =>  |   +---+
|       |      |   |   |
|       |      |   |   |
+-------+      +---+---+

Fibonacci

Rectangle is split in a “Fibonacci” pattern.

+-------+      +---+---+
|       |      |   |   |
|       |      |   |   |
|       |  =>  |   +-+-+
|       |      |   |_| |
|       |      |   | | |
+-------+      +---+---+

Dwindle

Rectangle is split in a “Fibonacci”-like pattern. But instead of spiraling into the middle, it spirals into the bottom right.

+-------+      +---+---+
|       |      |   |   |
|       |      |   |   |
|       |  =>  |   +-+-+
|       |      |   | |_|
|       |      |   | |||
+-------+      +---+---+

Trait Implementations

impl Clone for Split

fn clone(&self) -> Split

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Split

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Split

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Split

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Split

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Split

impl Eq for Split

impl StructuralPartialEq for Split