Struct ShiftOptions

pub struct ShiftOptions<Element: Clone + 'static, Window: Clone + 'static> {
    pub detect_overflow: Option<DetectOverflowOptions<Element>>,
    pub main_axis: Option<bool>,
    pub cross_axis: Option<bool>,
    pub limiter: Option<Box<dyn Limiter<Element, Window>>>,
}

Options for Shift middleware.

Fields

detect_overflow: Option<DetectOverflowOptions<Element>>

Options for detect_overflow.

Defaults to DetectOverflowOptions::default.

main_axis: Option<bool>

The axis that runs along the alignment of the floating element. Determines whether overflow along this axis is checked to perform shifting.

Defaults to true.

cross_axis: Option<bool>

The axis that runs along the side of the floating element. Determines whether overflow along this axis is checked to perform shifting.

Defaults to false.

limiter: Option<Box<dyn Limiter<Element, Window>>>

Accepts a limiter that limits the shifting done in order to prevent detachment.

Defaults to DefaultLimiter.

Implementations

impl<Element: Clone, Window: Clone> ShiftOptions<Element, Window>

pub fn detect_overflow(self, value: DetectOverflowOptions<Element>) -> Self

Set detect_overflow option.

pub fn main_axis(self, value: bool) -> Self

Set main_axis option.

pub fn cross_axis(self, value: bool) -> Self

Set cross_axis option.

pub fn limiter(self, value: Box<dyn Limiter<Element, Window>>) -> Self

Set limiter option.

Trait Implementations

impl<Element: Clone + Clone + 'static, Window: Clone + Clone + 'static> Clone for ShiftOptions<Element, Window>

fn clone(&self) -> ShiftOptions<Element, Window>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Element: Clone, Window: Clone> Default for ShiftOptions<Element, Window>

fn default() -> Self

Returns the “default value” for a type.

impl<Element: Clone, Window: Clone> MiddlewareWithOptions<Element, Window, ShiftOptions<Element, Window>> for Shift<'_, Element, Window>

fn options( &self, ) -> &Derivable<'_, Element, Window, ShiftOptions<Element, Window>>

The options passed to this middleware.

impl<Element: PartialEq + Clone + 'static, Window: PartialEq + Clone + 'static> PartialEq for ShiftOptions<Element, Window>

fn eq(&self, other: &ShiftOptions<Element, Window>) -> 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<Element: Clone + 'static, Window: Clone + 'static> StructuralPartialEq for ShiftOptions<Element, Window>