Struct CodeBlock 

pub struct CodeBlock<'a> {
    pub language: Option<Cow<'a, str>>,
    pub metadata: HashMap<Cow<'a, str>, Cow<'a, str>>,
    pub lines: Vec<Cow<'a, str>>,
}

Fields

language: Option<Cow<'a, str>>

Represents the language associated with the code block if it has one

metadata: HashMap<Cow<'a, str>, Cow<'a, str>>

Represents metadata associated with the code block in the form of key/value pairs

lines: Vec<Cow<'a, str>>

Represents the lines of text contained within the code block

Implementations

impl<'a> CodeBlock<'a>

pub fn new( language: Option<Cow<'a, str>>, metadata: HashMap<Cow<'a, str>, Cow<'a, str>>, lines: Vec<Cow<'a, str>>, ) -> CodeBlock<'a>

impl<'a> CodeBlock<'a>

pub fn from_lines<I: IntoIterator<Item = L>, L: Into<Cow<'a, str>>>( iter: I, ) -> Self

Constructs a code block with the provided lines using no language or metadata

impl CodeBlock<'_>

pub fn to_borrowed(&self) -> CodeBlock<'_>

pub fn into_owned(self) -> CodeBlock<'static>

Trait Implementations

impl<'a> Clone for CodeBlock<'a>

fn clone(&self) -> CodeBlock<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CodeBlock<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for CodeBlock<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<CodeBlock<'a>> for BlockElement<'a>

fn from(original: CodeBlock<'a>) -> BlockElement<'a>

Converts to this type from the input type.

impl<'a> From<CodeBlock<'a>> for Element<'a>

fn from(value: CodeBlock<'a>) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a str> for CodeBlock<'a>

fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self

Produces a new code block using the given iterator as the code block’s lines

impl<'a> FromIterator<Cow<'a, str>> for CodeBlock<'a>

fn from_iter<I: IntoIterator<Item = Cow<'a, str>>>(iter: I) -> Self

Produces a new code block using the given iterator as the code block’s lines

impl FromIterator<String> for CodeBlock<'static>

fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> Self

Produces a new code block using the given iterator as the code block’s lines

impl<'a, __IdxT> Index<__IdxT> for CodeBlock<'a>

where Vec<Cow<'a, str>>: Index<__IdxT>,

type Output = <Vec<Cow<'a, str>> as Index<__IdxT>>::Output

The returned type after indexing.

fn index(&self, idx: __IdxT) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, __IdxT> IndexMut<__IdxT> for CodeBlock<'a>

where Vec<Cow<'a, str>>: IndexMut<__IdxT>,

fn index_mut(&mut self, idx: __IdxT) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, '__deriveMoreLifetime> IntoIterator for &'__deriveMoreLifetime CodeBlock<'a>

type Item = <&'__deriveMoreLifetime Vec<Cow<'a, str>> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'__deriveMoreLifetime Vec<Cow<'a, str>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, '__deriveMoreLifetime> IntoIterator for &'__deriveMoreLifetime mut CodeBlock<'a>

type Item = <&'__deriveMoreLifetime mut Vec<Cow<'a, str>> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'__deriveMoreLifetime mut Vec<Cow<'a, str>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for CodeBlock<'a>

type Item = <Vec<Cow<'a, str>> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <Vec<Cow<'a, str>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> PartialEq for CodeBlock<'a>

fn eq(&self, other: &CodeBlock<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Serialize for CodeBlock<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StrictEq for CodeBlock<'a>

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

Same as PartialEq

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

impl<'a> Eq for CodeBlock<'a>

impl<'a> StructuralPartialEq for CodeBlock<'a>