Replace Effect::aux with e; merge fns runs, runs_with_effects #99
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43cfb05 to
4cc4985
Compare
dhardy
commented
Sep 1, 2025
Comment on lines
18
to
-31
| /// Effect formatting marker | ||
| #[derive(Clone, Debug, PartialEq, Eq)] | ||
| #[derive(Clone, Debug, Default, PartialEq, Eq)] | ||
| #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] | ||
| pub struct Effect<X> { | ||
| pub struct Effect { | ||
| /// Index in text at which formatting becomes active | ||
| /// | ||
| /// (Note that we use `u32` not `usize` since it can be assumed text length | ||
| /// will never exceed `u32::MAX`.) | ||
| pub start: u32, | ||
| /// User-specified value, e.g. index into a colour palette | ||
| pub e: u16, | ||
| /// Effect flags | ||
| pub flags: EffectFlags, | ||
| /// User payload | ||
| pub aux: X, | ||
| } |
There was a problem hiding this comment.
The new Effect struct.
Comment on lines
541
to
558
| /// Iterate over runs of positioned glyphs | ||
| /// | ||
| /// This method is just sugar for `self.runs_with_effects(&[], ())`. | ||
| /// All glyphs are translated by the given `offset` (this is practically | ||
| /// free). | ||
| /// | ||
| /// Runs are yielded in undefined order. The total number of | ||
| /// glyphs yielded will equal [`TextDisplay::num_glyphs`]. | ||
| pub fn runs(&self) -> Result<impl Iterator<Item = GlyphRun<'_, ()>>, NotReady> { | ||
| Ok(self.display()?.runs()) | ||
| } | ||
|
|
||
| /// Iterate over runs of positioned glyphs with effects | ||
| /// | ||
| /// The passed `effects` do not have to equal those associated with the text | ||
| /// `T`; it is fine to use an empty list instead (i.e. [`Self::runs`]) or | ||
| /// even synthesize a new list of effects. | ||
| /// | ||
| /// If the list `effects` is empty or has first entry with `start > 0`, the | ||
| /// result of `Effect::default(default_aux)` is used. The user payload of | ||
| /// type `X` is simply passed through to `f` and `g` calls and may be useful | ||
| /// for color information. | ||
| /// | ||
| /// This method is significantly more computationally expensive than [`Self::runs`]. | ||
| /// An [`Effect`] sequence supports underline, strikethrough and custom | ||
| /// indexing (e.g. for a color palette). Pass `&[]` if effects are not | ||
| /// required. (The default effect is always [`Effect::default()`].) | ||
| /// | ||
| /// Runs are yielded in undefined order. The total number of | ||
| /// glyphs yielded will equal [`TextDisplay::num_glyphs`]. | ||
| pub fn runs_with_effects<'a, X: Copy>( | ||
| pub fn runs<'a>( | ||
| &'a self, | ||
| effects: &'a [Effect<X>], | ||
| default_aux: X, | ||
| ) -> Result<impl Iterator<Item = GlyphRun<'a, X>> + 'a, NotReady> { | ||
| Ok(self.display()?.runs_with_effects(effects, default_aux)) | ||
| offset: Vec2, | ||
| effects: &'a [Effect], | ||
| ) -> Result<impl Iterator<Item = GlyphRun<'a>> + 'a, NotReady> { | ||
| Ok(self.display()?.runs(offset, effects)) | ||
| } |
There was a problem hiding this comment.
Merged fn runs takes an offset and effects in all cases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fn runsnow supports an offset.