Skip to main content

ShapingQueue

Struct ShapingQueue 

Source
pub(crate) struct ShapingQueue<'a> {
    queue: Vec<ShapingQueueText>,
    text: &'a str,
    line_breaker: LineBreaker,
    byte_range: Range<usize>,
    character_range: Range<usize>,
    resolved_script: Option<Script>,
}
Expand description

The ShapingQueue is responsible for shaping text during inline formatting context construction. It allows for shaping text across inline box boundaries. When pushing items to the queue, if the items are compatible pieces of text that can be shaped together, they are accumulated. The queue may be flushed in the given situations:

  • An incompatible piece of text (different fonts or certain style properties) is pushed to the queue.
  • A preserved newline or tab is pushed to the queue.
  • An inline box breaks shaping via padding, border, margins or a non-baseline vertical-align property.
  • Atomic content in the inline formatting context

Upon flushing, the ShapingQueue will shape any pending text and assign the resulting ShapedTextSlices to the originating TextRuns.

Fields§

§queue: Vec<ShapingQueueText>

The queue of items in the current batch that will be shaped together.

§text: &'a str

The text that will be used for shaping.

§line_breaker: LineBreaker

The line breaker that will be used to slice shaping results across on line break boundaries.

§byte_range: Range<usize>

The byte range of the text to shape in Self::text for the current batch. Only contiguous ranges can be shaped together.

§character_range: Range<usize>

The character range of the text to shape in Self::text for the current batch. Only contiguous ranges can be shaped together.

§resolved_script: Option<Script>

The resolved script for the current batch. This is used to gradually turn non-specific scripts into a resolved value for shaping.

Implementations§

Source§

impl<'a> ShapingQueue<'a>

Source

pub(crate) fn new(text: &'a str, line_break_options: LineBreakOptions) -> Self

Source

fn compatible_old_shaping_result( &self, character_count: usize, ) -> Option<Arc<ShapedText>>

Source

fn shape_batch(&self) -> Option<Arc<ShapedText>>

Source

pub(crate) fn flush(&mut self)

Flush this ShapingQueue. If any content had been collected up to this point, it will be shaped and the resulting ShapedTextSlices will be assigned to their originating TextRuns.

Source

fn compatible_with_batch(&self, text: &ShapingQueueText) -> bool

Source

fn push_text(&mut self, text: ShapingQueueText)

Source

pub(crate) fn push(&mut self, entry: ShapingQueueEntry)

Push a new ShapingQueueEntry on to this ShapingQueue, maybe flushing previously collected entries.

Auto Trait Implementations§

§

impl<'a> Freeze for ShapingQueue<'a>

§

impl<'a> !RefUnwindSafe for ShapingQueue<'a>

§

impl<'a> Send for ShapingQueue<'a>

§

impl<'a> Sync for ShapingQueue<'a>

§

impl<'a> Unpin for ShapingQueue<'a>

§

impl<'a> UnsafeUnpin for ShapingQueue<'a>

§

impl<'a> !UnwindSafe for ShapingQueue<'a>

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Filterable for T

Source§

fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more
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, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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<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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

impl<T> MaybeSendSync for T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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