pub struct Span<'a, Link = (), Font = Font> {
pub text: Cow<'a, str>,
pub size: Option<Pixels>,
pub line_height: Option<LineHeight>,
pub font: Option<Font>,
pub color: Option<Color>,
pub link: Option<Link>,
pub highlight: Option<Highlight>,
pub padding: Padding,
pub underline: bool,
pub strikethrough: bool,
}
Expand description
A span of text.
Fields§
§text: Cow<'a, str>
The Fragment
of text.
size: Option<Pixels>
§line_height: Option<LineHeight>
The LineHeight
of the Span
.
font: Option<Font>
The font of the Span
.
color: Option<Color>
§link: Option<Link>
The link of the Span
.
highlight: Option<Highlight>
§padding: Padding
§underline: bool
Whether the Span
should be underlined or not.
strikethrough: bool
Whether the Span
should be struck through or not.
Implementations§
source§impl<'a, Link, Font> Span<'a, Link, Font>
impl<'a, Link, Font> Span<'a, Link, Font>
sourcepub fn new(fragment: impl IntoFragment<'a>) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn new(fragment: impl IntoFragment<'a>) -> Span<'a, Link, Font>
advanced
only.Creates a new Span
of text with the given text fragment.
sourcepub fn size(self, size: impl Into<Pixels>) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn size(self, size: impl Into<Pixels>) -> Span<'a, Link, Font>
advanced
only.Sets the size of the Span
.
sourcepub fn line_height(
self,
line_height: impl Into<LineHeight>,
) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn line_height( self, line_height: impl Into<LineHeight>, ) -> Span<'a, Link, Font>
advanced
only.Sets the LineHeight
of the Span
.
sourcepub fn font(self, font: impl Into<Font>) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn font(self, font: impl Into<Font>) -> Span<'a, Link, Font>
advanced
only.Sets the font of the Span
.
sourcepub fn font_maybe(self, font: Option<impl Into<Font>>) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn font_maybe(self, font: Option<impl Into<Font>>) -> Span<'a, Link, Font>
advanced
only.Sets the font of the Span
, if any.
sourcepub fn color(self, color: impl Into<Color>) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn color(self, color: impl Into<Color>) -> Span<'a, Link, Font>
advanced
only.sourcepub fn color_maybe(
self,
color: Option<impl Into<Color>>,
) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn color_maybe( self, color: Option<impl Into<Color>>, ) -> Span<'a, Link, Font>
advanced
only.sourcepub fn link(self, link: impl Into<Link>) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn link(self, link: impl Into<Link>) -> Span<'a, Link, Font>
advanced
only.Sets the link of the Span
.
sourcepub fn link_maybe(self, link: Option<impl Into<Link>>) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn link_maybe(self, link: Option<impl Into<Link>>) -> Span<'a, Link, Font>
advanced
only.Sets the link of the Span
, if any.
sourcepub fn background(
self,
background: impl Into<Background>,
) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn background( self, background: impl Into<Background>, ) -> Span<'a, Link, Font>
advanced
only.Sets the Background
of the Span
.
sourcepub fn background_maybe(
self,
background: Option<impl Into<Background>>,
) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn background_maybe( self, background: Option<impl Into<Background>>, ) -> Span<'a, Link, Font>
advanced
only.Sets the Background
of the Span
, if any.
sourcepub fn border(self, border: impl Into<Border>) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn border(self, border: impl Into<Border>) -> Span<'a, Link, Font>
advanced
only.sourcepub fn border_maybe(
self,
border: Option<impl Into<Border>>,
) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn border_maybe( self, border: Option<impl Into<Border>>, ) -> Span<'a, Link, Font>
advanced
only.sourcepub fn padding(self, padding: impl Into<Padding>) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn padding(self, padding: impl Into<Padding>) -> Span<'a, Link, Font>
advanced
only.It only affects the background
and border
of the
Span
, currently.
sourcepub fn underline(self, underline: bool) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn underline(self, underline: bool) -> Span<'a, Link, Font>
advanced
only.Sets whether the Span
shoud be underlined or not.
sourcepub fn strikethrough(self, strikethrough: bool) -> Span<'a, Link, Font>
Available on crate feature advanced
only.
pub fn strikethrough(self, strikethrough: bool) -> Span<'a, Link, Font>
advanced
only.Sets whether the Span
shoud be struck through or not.
Trait Implementations§
source§impl<'a, Link, Theme, Renderer> FromIterator<Span<'a, Link, <Renderer as Renderer>::Font>> for Rich<'a, Link, Theme, Renderer>
impl<'a, Link, Theme, Renderer> FromIterator<Span<'a, Link, <Renderer as Renderer>::Font>> for Rich<'a, Link, Theme, Renderer>
Auto Trait Implementations§
impl<'a, Link, Font> Freeze for Span<'a, Link, Font>
impl<'a, Link, Font> RefUnwindSafe for Span<'a, Link, Font>where
Font: RefUnwindSafe,
Link: RefUnwindSafe,
impl<'a, Link, Font> Send for Span<'a, Link, Font>
impl<'a, Link, Font> Sync for Span<'a, Link, Font>
impl<'a, Link, Font> Unpin for Span<'a, Link, Font>
impl<'a, Link, Font> UnwindSafe for Span<'a, Link, Font>where
Font: UnwindSafe,
Link: UnwindSafe,
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
Convert the source color to the destination color using the specified
method.
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
Convert the source color to the destination color using the bradford
method by default.
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
Cast a collection of colors into a collection of arrays.
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
Cast this collection of arrays into a collection of colors.
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
The number type that’s used in
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
Converts
self
into C
, using the provided parameters.source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
Cast a collection of colors into a collection of color components.
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
Performs a conversion from
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
Converts
other
into Self
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
Performs a conversion into
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
The number type that’s used in
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
Converts
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
Convert into T with values clamped to the color defined bounds Read more
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
Convert into T. The resulting color might be invalid in its color space Read more
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
Converts
self
into T
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
The error for when
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
Try to cast this collection of color components into a collection of
colors. Read more
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
Convert into T, returning ok if the color is inside of its defined
range, otherwise an
OutOfBounds
error is returned which contains
the unclamped color. Read moresource§impl<C, U> UintsFrom<C> for Uwhere
C: IntoUints<U>,
impl<C, U> UintsFrom<C> for Uwhere
C: IntoUints<U>,
source§fn uints_from(colors: C) -> U
fn uints_from(colors: C) -> U
Cast a collection of colors into a collection of unsigned integers.
source§impl<C, U> UintsInto<C> for Uwhere
C: FromUints<U>,
impl<C, U> UintsInto<C> for Uwhere
C: FromUints<U>,
source§fn uints_into(self) -> C
fn uints_into(self) -> C
Cast this collection of unsigned integers into a collection of colors.