Skip to main content

Code

Struct Code 

Source
pub struct Code {
    pub common: Common,
    pub source: String,
    pub language: Option<String>,
    pub line_numbers: Option<bool>,
    pub start_line: Option<u32>,
    pub highlight_lines: Vec<u32>,
    pub wrap: Option<bool>,
}
Expand description

Syntax-highlighted code (§4.5.2). TUI: syntect; app: the chat code-block renderer.

Fields§

§common: Common

Common node props (key, style, block, fallback).

§source: String

Code source.

§language: Option<String>

Language id (rust, mermaid, …).

§line_numbers: Option<bool>

Render line numbers.

§start_line: Option<u32>

First line number (default 1).

§highlight_lines: Vec<u32>

Highlighted (1-based) line numbers.

§wrap: Option<bool>

Wrap long lines (default false = horizontal scroll).

Implementations§

Source§

impl Code

Source

pub fn new(source: impl Into<String>) -> Self

A code node.

Source

pub fn language(self, language: impl Into<String>) -> Self

Sets the language id.

Source

pub fn line_numbers(self, line_numbers: bool) -> Self

Renders line numbers.

Source

pub fn start_line(self, start_line: u32) -> Self

Sets the first line number.

Source

pub fn highlight_lines(self, lines: impl IntoIterator<Item = u32>) -> Self

Sets the highlighted (1-based) lines.

Source

pub fn wrap(self, wrap: bool) -> Self

Wraps long lines.

Trait Implementations§

Source§

impl Clone for Code

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 Code

Source§

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

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

impl Default for Code

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Code

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<Code> for Node

Source§

fn from(c: Code) -> Self

Converts to this type from the input type.
Source§

impl IntoNode for Code

Source§

fn into_node(self) -> Node

Converts into a node.
Source§

impl PartialEq for Code

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 Serialize for Code

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Code

Source§

impl WithCommon for Code

Source§

fn common_mut(&mut self) -> &mut Common

Mutable access to the node’s common props.
Source§

fn key(self, key: impl Into<Key>) -> Self

Sets the node key.
Source§

fn style(self, style: Style) -> Self

Sets the base style.
Source§

fn block(self, block: impl Into<BlockProps>) -> Self

Sets the surrounding block.
Source§

fn fallback(self, node: impl Into<Node>) -> Self

Sets the fallback node.

Auto Trait Implementations§

§

impl Freeze for Code

§

impl RefUnwindSafe for Code

§

impl Send for Code

§

impl Sync for Code

§

impl Unpin for Code

§

impl UnsafeUnpin for Code

§

impl UnwindSafe for Code

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.