Skip to main content

CodeBlock

Struct CodeBlock 

Source
pub struct CodeBlock { /* private fields */ }
Expand description

An immutable code fragment with embedded type references.

CodeBlock is the core composition primitive in sigil-stitch. It stores a tree of CodeNode nodes — self-contained IR nodes produced from format strings (%T, %N, %S, %L, etc.). CodeBlocks are produced by CodeBlockBuilder and consumed by FileSpec during rendering. Type references embedded via %T are automatically tracked for import resolution.

Use CodeBlock::builder() to construct a block incrementally, or CodeBlock::of() for simple one-liners.

§Examples

use sigil_stitch::code_block::CodeBlock;
use sigil_stitch::lang::typescript::TypeScript;
use sigil_stitch::type_name::TypeName;

// One-liner with a type reference:
let user = TypeName::importable("./models", "User");
let block = CodeBlock::of("const u: %T = getUser()", (user,)).unwrap();

// Multi-statement block via builder:
let mut cb = CodeBlock::builder();
cb.add_statement("const x = 1", ());
cb.add_statement("const y = 2", ());
let block = cb.build().unwrap();

Implementations§

Source§

impl CodeBlock

Source

pub fn builder() -> CodeBlockBuilder

Create a new CodeBlockBuilder.

Source

pub fn of(format: &str, args: impl IntoArgs) -> Result<Self, SigilStitchError>

Create a CodeBlock from a single format string and arguments.

Source

pub fn is_empty(&self) -> bool

Check if this code block is empty.

Source

pub fn collect_imports(&self, out: &mut Vec<ImportRef>)

Collect all import references from this code block.

Source

pub fn render_standalone( &self, lang: &dyn CodeLang, width: usize, ) -> Result<String, SigilStitchError>

Render this code block to a string without import resolution.

Creates a temporary empty import group and renders using the given language and target line width. Useful for quick one-off rendering in tests or when import management is not needed.

Trait Implementations§

Source§

impl Clone for CodeBlock

Source§

fn clone(&self) -> CodeBlock

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CodeBlock

Source§

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

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

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

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<CodeBlock> for Arg

Source§

fn from(cb: CodeBlock) -> Self

Converts to this type from the input type.
Source§

impl IntoArgs for CodeBlock

Single CodeBlock arg.

Source§

fn into_args(self) -> Vec<Arg>

Convert into a vector of format arguments.
Source§

impl Serialize for CodeBlock

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

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,