Struct FlipOptions

Source
pub struct FlipOptions<Element: Clone> {
    pub detect_overflow: Option<DetectOverflowOptions<Element>>,
    pub main_axis: Option<bool>,
    pub cross_axis: Option<CrossAxis>,
    pub fallback_placements: Option<Vec<Placement>>,
    pub fallback_strategy: Option<FallbackStrategy>,
    pub fallback_axis_side_direction: Option<Alignment>,
    pub flip_alignment: Option<bool>,
}
Expand description

Options for Flip middleware.

Fields§

§detect_overflow: Option<DetectOverflowOptions<Element>>§main_axis: Option<bool>

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

Defaults to true.

§cross_axis: Option<CrossAxis>

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

Defaults to true.

§fallback_placements: Option<Vec<Placement>>

Placements to try sequentially if the preferred placement does not fit.

Defaults to the opposite placement.

§fallback_strategy: Option<FallbackStrategy>

What strategy to use when no placements fit.

Defaults to FallbackStrategy::BestFit.

§fallback_axis_side_direction: Option<Alignment>

Whether to allow fallback to the perpendicular axis of the preferred placement, and if so, which side direction along the axis to prefer.

Defaults to Option::None (disallow fallback).

§flip_alignment: Option<bool>

Whether to flip to placements with the opposite alignment if they fit better.

Defaults to true.

Implementations§

Source§

impl<Element: Clone> FlipOptions<Element>

Source

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

Set detect_overflow option.

Source

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

Set main_axis option.

Source

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

Set cross_axis option.

Source

pub fn fallback_placements(self, value: Vec<Placement>) -> Self

Set fallback_placements option.

Source

pub fn fallback_strategy(self, value: FallbackStrategy) -> Self

Set fallback_strategy option.

Source

pub fn fallback_axis_side_direction(self, value: Alignment) -> Self

Set fallback_axis_side_direction option.

Source

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

Set flip_alignment option.

Trait Implementations§

Source§

impl<Element: Clone + Clone> Clone for FlipOptions<Element>

Source§

fn clone(&self) -> FlipOptions<Element>

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<Element: Debug + Clone> Debug for FlipOptions<Element>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Element: Clone> Default for FlipOptions<Element>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<Element: Clone, Window: Clone> MiddlewareWithOptions<Element, Window, FlipOptions<Element>> for Flip<'_, Element, Window>

Source§

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

The options passed to this middleware.
Source§

impl<Element: PartialEq + Clone> PartialEq for FlipOptions<Element>

Source§

fn eq(&self, other: &FlipOptions<Element>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<Element: Clone> StructuralPartialEq for FlipOptions<Element>

Auto Trait Implementations§

§

impl<Element> Freeze for FlipOptions<Element>
where Element: Freeze,

§

impl<Element> RefUnwindSafe for FlipOptions<Element>
where Element: RefUnwindSafe,

§

impl<Element> Send for FlipOptions<Element>
where Element: Send,

§

impl<Element> Sync for FlipOptions<Element>
where Element: Sync,

§

impl<Element> Unpin for FlipOptions<Element>
where Element: Unpin,

§

impl<Element> UnwindSafe for FlipOptions<Element>
where Element: UnwindSafe,

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> Clone for T
where T: Clone,

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> Dyn for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Source§

fn as_any_box(self: Box<T>) -> Box<dyn Any>

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> PartialEq for T
where T: Dyn + PartialEq,

Source§

fn dyn_eq(&self, other: &(dyn Any + 'static)) -> bool

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.