Enum Placement

#[non_exhaustive]
pub enum Placement {
    None,
    Above,
    Below,
    Left,
    Right,
    AboveOrBelow,
    BelowOrAbove,
    Position(u16, u16),
}

Placement of the popup.

This enum is for use in a widget that then uses PopupCore internally. Expose Placement to the users of your widget to let them define a popup placement. Convert the Placement to a PopupConstraint internally when forwarding this to PopupCore.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

Use the render-area for the popup as is.

Above

Place above the given area.

Below

Place below the given area:

Left

Place left of the given area.

Right

Place right of the given area.

AboveOrBelow

Above or below dependent on available space. Aligned left.

BelowOrAbove

Below or above dependent on available space. Aligned left.

Position(u16, u16)

Use the render-area for the popup, but place it at position (x,y).

Implementations

impl Placement

pub fn into_constraint( self, alignment: Alignment, rel_area: Rect, ) -> PopupConstraint

Trait Implementations

impl Clone for Placement

fn clone(&self) -> Placement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Placement

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

Formats the value using the given formatter.

impl Default for Placement

fn default() -> Placement

Returns the “default value” for a type.

impl PartialEq for Placement

fn eq(&self, other: &Placement) -> 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 Copy for Placement

impl Eq for Placement

impl StructuralPartialEq for Placement