Struct kas_text::Effect

pub struct Effect<X> {
    pub start: u32,
    pub flags: EffectFlags,
    pub aux: X,
}

Effect formatting marker

Fields

start: u32

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

flags: EffectFlags

Effect flags

aux: X

User payload

Implementations

impl<X> Effect<X>

pub fn default(aux: X) -> Self

Construct a “default” instance with the supplied aux value

Trait Implementations

impl<X: Clone> Clone for Effect<X>

fn clone(&self) -> Effect<X>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<X: Debug> Debug for Effect<X>

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

Formats the value using the given formatter.

impl<X: PartialEq> PartialEq<Effect<X>> for Effect<X>

fn eq(&self, other: &Effect<X>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<X: Eq> Eq for Effect<X>

impl<X> StructuralEq for Effect<X>

impl<X> StructuralPartialEq for Effect<X>