Skip to main content

CodeHighlightBuilder

Struct CodeHighlightBuilder 

Source
pub struct CodeHighlightBuilder { /* private fields */ }
Expand description

Builder for an animation of highlighting code by line range or regex pattern.

               code.highlight()
                   .lines(3..6)
                   .color(Color::new(1.0, 1.0, 0.0, 0.3))
                   .over(1.s())
                   .ease(Ease::InOutCubic),

Or with a regex pattern:

               code.highlight()
                   .pattern(r"fn \w+\(")
                   .color(Color::new(0.0, 1.0, 0.0, 0.3))
                   .over(1.s()),

Implementations§

Source§

impl CodeHighlightBuilder

Source

pub fn lines(self, range: Range<usize>) -> Self

Highlight a range of lines (can be called multiple times for multiple ranges)

Source

pub fn pattern(self, regex: impl Into<String>) -> Self

Highlight lines matching a regex pattern

Source

pub fn color(self, color: Color) -> Self

Color of the highlight overlay

Source

pub fn over(self, duration: Time) -> Self

Duration of the highlight animation

Source

pub fn ease(self, ease: Ease) -> Self

Ease function for the highlight animation

Trait Implementations§

Source§

impl From<CodeHighlightBuilder> for AnimOP

Source§

fn from(b: CodeHighlightBuilder) -> Self

Converts to this type from the input type.
Source§

impl IntoAnimOp for CodeHighlightBuilder

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> 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, 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.