Struct Span

Source
pub struct Span<'a, Link = (), Font = Font> {
    pub text: Fragment<'a>,
    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: Fragment<'a>

The Fragment of text.

§size: Option<Pixels>

The size of the Span in Pixels.

§line_height: Option<LineHeight>

The LineHeight of the Span.

§font: Option<Font>

The font of the Span.

§color: Option<Color>

The Color of the Span.

§link: Option<Link>

The link of the Span.

§highlight: Option<Highlight>

The Highlight of the Span.

§padding: Padding

The Padding of the Span.

Currently, it only affects the bounds of the Highlight.

§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>

Source

pub fn new(fragment: impl IntoFragment<'a>) -> Self

Creates a new Span of text with the given text fragment.

Source

pub fn size(self, size: impl Into<Pixels>) -> Self

Sets the size of the Span.

Source

pub fn line_height(self, line_height: impl Into<LineHeight>) -> Self

Sets the LineHeight of the Span.

Source

pub fn font(self, font: impl Into<Font>) -> Self

Sets the font of the Span.

Source

pub fn font_maybe(self, font: Option<impl Into<Font>>) -> Self

Sets the font of the Span, if any.

Source

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

Sets the Color of the Span.

Source

pub fn color_maybe(self, color: Option<impl Into<Color>>) -> Self

Sets the Color of the Span, if any.

Sets the link of the Span.

Sets the link of the Span, if any.

Source

pub fn background(self, background: impl Into<Background>) -> Self

Sets the Background of the Span.

Source

pub fn background_maybe(self, background: Option<impl Into<Background>>) -> Self

Sets the Background of the Span, if any.

Source

pub fn border(self, border: impl Into<Border>) -> Self

Sets the Border of the Span.

Source

pub fn border_maybe(self, border: Option<impl Into<Border>>) -> Self

Sets the Border of the Span, if any.

Source

pub fn padding(self, padding: impl Into<Padding>) -> Self

Sets the Padding of the Span.

It only affects the background and border of the Span, currently.

Source

pub fn underline(self, underline: bool) -> Self

Sets whether the Span should be underlined or not.

Source

pub fn strikethrough(self, strikethrough: bool) -> Self

Sets whether the Span should be struck through or not.

Source

pub fn to_static(self) -> Span<'static, Link, Font>

Turns the Span into a static one.

Trait Implementations§

Source§

impl<'a, Link: Clone, Font: Clone> Clone for Span<'a, Link, Font>

Source§

fn clone(&self) -> Span<'a, Link, Font>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, Link: Debug, Font: Debug> Debug for Span<'a, Link, Font>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Link, Font> Default for Span<'_, Link, Font>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a, Link, Font> From<&'a str> for Span<'a, Link, Font>

Source§

fn from(value: &'a str) -> Self

Converts to this type from the input type.
Source§

impl<Link, Font: PartialEq> PartialEq for Span<'_, Link, Font>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

Auto Trait Implementations§

§

impl<'a, Link, Font> Freeze for Span<'a, Link, Font>
where Font: Freeze, Link: Freeze,

§

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>
where Font: Send, Link: Send,

§

impl<'a, Link, Font> Sync for Span<'a, Link, Font>
where Font: Sync, Link: Sync,

§

impl<'a, Link, Font> Unpin for Span<'a, Link, Font>
where Font: Unpin, Link: Unpin,

§

impl<'a, Link, Font> UnwindSafe for Span<'a, Link, Font>
where Font: UnwindSafe, Link: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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

§

impl<T> MaybeSendSync for T