Struct layout_2020::flow::float::FloatContext

source ·
pub struct FloatContext {
    pub bands: FloatBandTree,
    pub ceiling_from_floats: Au,
    pub ceiling_from_non_floats: Au,
    pub containing_block_info: ContainingBlockPositionInfo,
    pub clear_inline_start_position: Au,
    pub clear_inline_end_position: Au,
}
Expand description

Data kept during layout about the floats in a given block formatting context.

This is a persistent data structure. Each float has its own private copy of the float context, although such copies may share portions of the bands tree.

Fields§

§bands: FloatBandTree

A persistent AA tree of float bands.

This tree is immutable; modification operations return the new tree, which may share nodes with previous versions of the tree.

§ceiling_from_floats: Au

The block-direction “ceiling” defined by the placement of other floated content of this FloatContext. No new floats can be placed at a lower block start than this value.

§ceiling_from_non_floats: Au

The block-direction “ceiling” defined by the placement of non-floated content that precedes floated content in the document. Note that this may actually decrease as content is laid out in the case that content overflows its container.

§containing_block_info: ContainingBlockPositionInfo

Details about the position of the containing block relative to the independent block formatting context that contains all of the floats this FloatContext positions.

§clear_inline_start_position: Au

The (logically) lowest margin edge of the last inline-start float.

§clear_inline_end_position: Au

The (logically) lowest margin edge of the last inline-end float.

Implementations§

source§

impl FloatContext

source

pub fn new(max_inline_size: Au) -> Self

Returns a new float context representing a containing block with the given content inline-size.

source

pub fn set_ceiling_from_non_floats(&mut self, new_ceiling: Au)

(Logically) lowers the ceiling to at least new_ceiling units.

If the ceiling is already logically lower (i.e. larger) than this, does nothing.

source

fn ceiling(&mut self) -> Au

The “ceiling” used for float placement. This is the minimum block position value that should be used for placing any new float.

source

pub(crate) fn place_object( &self, object: &PlacementInfo, ceiling: Au, ) -> LogicalVec2<Au>

Determines where a float with the given placement would go, but leaves the float context unmodified. Returns the start corner of its margin box.

This should be used for placing inline elements and block formatting contexts so that they don’t collide with floats.

source

pub fn add_float(&mut self, new_float: &PlacementInfo) -> LogicalVec2<Au>

Places a new float and adds it to the list. Returns the start corner of its margin box.

Trait Implementations§

source§

impl Clone for FloatContext

source§

fn clone(&self) -> FloatContext

Returns a copy 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 Debug for FloatContext

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> MaybeBoxed<Box<T>> for T

source§

fn maybe_boxed(self) -> Box<T>

Convert
source§

impl<T> MaybeBoxed<T> for T

source§

fn maybe_boxed(self) -> T

Convert
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
source§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
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.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,