Struct somedoc::model::block::Paragraph

pub struct Paragraph { /* fields omitted */ }

A paragraph is a bounded block of inline content, usually text.

Implementations

impl Paragraph

pub fn with_alignment(inner: &str, alignment: Alignment) -> Self

Create a new instance with the string as inline content and the provided alignment.

Trait Implementations

impl Clone for Paragraph

fn clone(&self) -> Paragraph

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Paragraph

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

Formats the value using the given formatter.

impl Default for Paragraph

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Paragraph

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 Paragraph

fn from(s: &str) -> Self

Performs the conversion.

impl From<InlineContent> for Paragraph

fn from(value: InlineContent) -> Self

Performs the conversion.

impl From<String> for Paragraph

fn from(s: String) -> Self

Performs the conversion.

impl From<Vec<InlineContent, Global>> for Paragraph

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

Performs the conversion.

impl HasAlignment for Paragraph

fn alignment(&self) -> &Alignment

Return the alignment for this paragraph.

fn set_alignment(&mut self, alignment: Alignment) -> &mut Self

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

Set the alignment to left aligned, right ragged.

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

Set the alignment to right aligned, left ragged.

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

Set the alignment to right aligned, left ragged.

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

Set the alignment to left aligned, right ragged.

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

Set the alignment to centered, left and right ragged.

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

Set the alignment to justified, neither left or right ragged.

impl HasInlineContent for Paragraph

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 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_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 Paragraph

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 HasLabel for Paragraph

fn has_label(&self) -> bool

Returns true if this element has a label, else false.

fn label(&self) -> &Option<Label>

Return the element's label, if present.

fn set_label(&mut self, label: Label) -> &mut Self

Set the current element's label value.

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

Set the current element's label to None.

impl Into<BlockContent> for Paragraph

fn into(self) -> BlockContent

Performs the conversion.

impl Serialize for Paragraph

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

Serialize this value into the given Serde serializer.