Struct Span 

pub struct Span { /* private fields */ }

A span consists of a list of styles to apply to an inner list of inline content.

Implementations

impl Span

pub fn with_style(inner: &str, style: SpanStyle) -> Self

Create a new span, with the provided style, that includes a Text instance.

pub fn with_styles(inner: &str, styles: Vec<SpanStyle>) -> Self

Create a new span, with the provided styles, that includes a Text instance.

pub fn inner_with_style(inner: InlineContent, style: SpanStyle) -> Self

Create a new span, with the provided style, that includes a InlineContent instance.

pub fn inner_with_styles(inner: InlineContent, styles: Vec<SpanStyle>) -> Self

Create a new span, with the provided style, that includes a InlineContent instance.

pub fn space() -> Self

Create a new span containing simply a space character.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl Default for Span

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Span

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for Span

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<InlineContent> for Span

fn from(value: InlineContent) -> Self

Converts to this type from the input type.

impl From<String> for Span

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<InlineContent>> for Span

fn from(value: Vec<InlineContent>) -> Self

Converts to this type from the input type.

impl HasInlineContent for Span

fn link(inner: HyperLink) -> Self

Create a new inline content container from the provided HyperLink content item.

fn image(inner: Image) -> Self

Create a new inline content container from the provided Image content item.

fn text(inner: Text) -> Self

Create a new inline content container from the provided Text content item.

fn math(inner: Math) -> Self

Create a new inline content container from the provided Math content item.

fn text_str(inner: &str) -> Self

Create a new inline content container from the provided string (into Text) content item.

fn character(inner: Character) -> Self

Create a new inline content container from the provided Character content item.

fn line_break() -> Self

Create a new inline content container with a line break.

fn span(span: Span) -> Self

Create a new inline content container from the provided Span content item.

fn add_link(&mut self, inner: HyperLink) -> &mut Self

Add the provided HyperLink to this container’s inner content.

fn add_image(&mut self, inner: Image) -> &mut Self

Add the provided Image to this container’s inner content.

fn add_text(&mut self, inner: Text) -> &mut Self

Add the provided Text to this container’s inner content.

fn add_text_str(&mut self, inner: &str) -> &mut Self

Add the provided string (as Text) to this container’s inner content.

fn add_math(&mut self, inner: Math) -> &mut Self

Add the provided Math to this container’s inner content.

fn add_character(&mut self, inner: Character) -> &mut Self

Add the provided Character to this container’s inner content.

fn add_space(&mut self) -> &mut Self

Add a single space to this container’s inner content.

fn add_non_breaking_space(&mut self) -> &mut Self

Add a single non-breaking space to this container’s inner content.

fn add_line_break(&mut self) -> &mut Self

Add a LineBreak to this container’s inner content.

fn add_span(&mut self, inner: Span) -> &mut Self

Add the provided Span to this container’s inner content.

fn plain(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::Plain applied to the provided content.

fn plain_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::Plain applied to the provided string as a Text instance.

fn italic(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::Italic applied to the provided content.

fn italic_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::Italic applied to the provided string as a Text instance.

fn bold(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::Bold applied to the provided content.

fn bold_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::Bold applied to the provided string as a Text instance.

fn mono(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::Mono applied to the provided content.

fn mono_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::Mono applied to the provided string as a Text instance.

fn code(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::Code applied to the provided content.

fn code_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::Code applied to the provided string as a Text instance.

fn strikethrough(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::Strikethrough applied to the provided content.

fn strikethrough_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::Strikethrough applied to the provided string as a Text instance.

fn underline(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::Underline applied to the provided content.

fn underline_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::Underline applied to the provided string as a Text instance.

fn small_caps(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::SmallCaps applied to the provided content.

fn small_caps_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::SmallCaps applied to the provided string as a Text instance.

fn superscript(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::Superscript applied to the provided content.

fn superscript_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::Superscript applied to the provided string as a Text instance.

fn subscript(inner: InlineContent) -> Self

Create a new inline content container as a Span, with TextStyle::Subscript applied to the provided content.

fn subscript_str(inner: &str) -> Self

Create a new inline content container as a Span, with TextStyle::Subscript applied to the provided string as a Text instance.

fn unformatted_string(&self) -> String

Return a string that is simply the Text instances (recursively) concatenated. This removes any style information and non-text instances such as images or links.

impl HasInnerContent<InlineContent> for Span

fn inner(&self) -> &Vec<InlineContent>

Return a reference to the inner value.

fn into_inner(self) -> Vec<InlineContent>

Return the inner value, consuming self.

fn inner_mut(&mut self) -> &mut Vec<InlineContent>

Return a mutable reference to the inner list of content.

fn add_content(&mut self, content: InlineContent) -> Result<()>

Add content to the inner list of content. If there is some consistency condition that would be broken by this addition an error will be returned.

fn has_inner(&self) -> bool

Returns true if the inner list of content is not empty, else false.

impl HasStyles<SpanStyle> for Span

fn styles(&self) -> &Vec<SpanStyle>

Return a reference to the list of applied styles.

fn styles_mut(&mut self) -> &mut Vec<SpanStyle>

Return a mutable reference to the list of applied styles.

fn add_style(&mut self, style: SpanStyle) -> Result<()>

Add content to the list of applied styles. If there is some consistency condition that would be broken by this addition an error will be returned.

fn has_styles(&self) -> bool

Returns true if the list of applied styles is not empty, else false.

impl Into<InlineContent> for Span

fn into(self) -> InlineContent

Converts this type into the (usually inferred) input type.

impl Serialize for Span

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.