iced::widget::text

Struct Span

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>

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§

impl<'a, Link, Font> Span<'a, Link, Font>

pub fn new(fragment: impl IntoFragment<'a>) -> Span<'a, Link, Font>

Available on crate feature advanced only.

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

pub fn size(self, size: impl Into<Pixels>) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the size of the Span.

pub fn line_height( self, line_height: impl Into<LineHeight>, ) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the LineHeight of the Span.

pub fn font(self, font: impl Into<Font>) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the font of the Span.

pub fn font_maybe(self, font: Option<impl Into<Font>>) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the font of the Span, if any.

pub fn color(self, color: impl Into<Color>) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the Color of the Span.

pub fn color_maybe( self, color: Option<impl Into<Color>>, ) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the Color of the Span, if any.

pub fn link(self, link: impl Into<Link>) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the link of the Span.

pub fn link_maybe(self, link: Option<impl Into<Link>>) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the link of the Span, if any.

pub fn background( self, background: impl Into<Background>, ) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the Background of the Span.

pub fn background_maybe( self, background: Option<impl Into<Background>>, ) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the Background of the Span, if any.

pub fn border(self, border: impl Into<Border>) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the Border of the Span.

pub fn border_maybe( self, border: Option<impl Into<Border>>, ) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the Border of the Span, if any.

pub fn padding(self, padding: impl Into<Padding>) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets the Padding of the Span.

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

pub fn underline(self, underline: bool) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets whether the Span should be underlined or not.

pub fn strikethrough(self, strikethrough: bool) -> Span<'a, Link, Font>

Available on crate feature advanced only.

Sets whether the Span should be struck through or not.

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

Available on crate feature advanced only.

Turns the Span into a static one.

Trait Implementations§

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

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

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

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

Formats the value using the given formatter. Read more

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

fn default() -> Span<'_, Link, Font>

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

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

fn from(value: &'a str) -> Span<'a, Link, Font>

Converts to this type from the input type.

impl<'a, Link, Message, Theme, Renderer> FromIterator<Span<'a, Link, <Renderer as Renderer>::Font>> for Rich<'a, Link, Message, Theme, Renderer>
where Link: Clone + 'a, Theme: Catalog, Renderer: Renderer, <Renderer as Renderer>::Font: 'a,

fn from_iter<T>(spans: T) -> Rich<'a, Link, Message, Theme, Renderer>
where T: IntoIterator<Item = Span<'a, Link, <Renderer as Renderer>::Font>>,

Creates a value from an iterator. Read more

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

fn eq(&self, other: &Span<'_, Link, Font>) -> 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§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T
where T: 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>

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)

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)

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
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<T> From<T> for T

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

impl<T, U> Into<U> for T
where U: From<T>,

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<State, Message> IntoBoot<State, Message> for State

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.

impl<T> IntoEither for T

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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more

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

type NoneType = T

fn null_value() -> T

The none-equivalent value.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

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> MaybeSend for T
where T: Send,

impl<T> MaybeSendSync for T

impl<T> MaybeSync for T
where T: Sync,

impl<T> Message for T
where T: Send + Debug + Clone,

impl<T> WasmNotSend for T
where T: Send,

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

impl<T> WasmNotSync for T
where T: Sync,