Skip to main content

Paragraph

Struct Paragraph 

Source
pub struct Paragraph {
    pub meta: NodeMeta,
    pub children: Vec<Inline>,
    /* private fields */
}
Expand description

A paragraph: a run of inline content. Source: any plain text line(s).

Fields§

§meta: NodeMeta

Node metadata (source span).

§children: Vec<Inline>

The paragraph’s inline content.

Implementations§

Source§

impl Paragraph

Source

pub fn new<I, T>(children: I) -> Self
where I: IntoIterator<Item = T>, T: Into<Inline>,

A paragraph from any iterator of inline-convertible children.

Source

pub fn with_source( text: &str, definitions: &Definitions, ) -> (Self, Vec<Diagnostic>)

A paragraph whose content is text, read as parse_inline reads it with definitions, and the diagnostics of that read. The paragraph keeps text, which the writer writes in place of its inlines while they are the ones text reads as; the spans of its inlines are offsets in text. Pass the definitions of the document the paragraph will be written in (Definitions::of); after they change, or for a leaf built with others, Document::reread_kept_sources reads its text again.

Source

pub fn source(&self) -> Option<&str>

The text Paragraph::with_source built the paragraph from.

Trait Implementations§

Source§

impl Clone for Paragraph

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Paragraph

Source§

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

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

impl Eq for Paragraph

Source§

impl From<Paragraph> for Block

Source§

fn from(node: Paragraph) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Paragraph

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Paragraph

Auto Trait Implementations§

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.

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.

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.