Struct CreateBuilder 

pub struct CreateBuilder { /* private fields */ }

Build a create mutation. Writes a new .md file under folder with name name (the .md extension is appended automatically).

Frontmatter is composed in three layers, in order of precedence:

1. Template — if template(path) is set, the template’s frontmatter is parsed as the base. Template body is preserved.
2. --set overrides — anything set via set() overrides matching template fields.
3. Schema defaults — when with_schema(schema) is supplied, every default: / default_expr: whose field isn’t already set by the template or --set is applied.

After composition, schema’s required: list is checked. Missing required fields surface as MutationErrors in the report, with the file NOT written.

Implementations

impl CreateBuilder

pub fn new(folder: impl Into<String>, name: impl Into<String>) -> Self

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

Set the body content. Overrides the template’s body (if any) and the default # {name} placeholder. Written verbatim.

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

Path to a template file, relative to the vault root. The template’s frontmatter forms the base of the new note; its body is preserved.

pub fn set(self, field: impl Into<String>, value: Value) -> Self

Set (or override) a frontmatter field. Layered on top of the template; layered under schema defaults.

pub fn with_schema(self, schema: CollectionSchema) -> Self

Attach a single collection schema. Convenience wrapper that builds a one-collection [VaultSchema] and forwards to Self::with_vault_schema. The compute path is identical — applicable_collections will pick this collection iff its folder is == or ancestor of the builder’s target folder and the filter (if any) matches the projected record.

pub fn with_vault_schema(self, schema: VaultSchema) -> Self

Attach the vault-wide schema. Every collection whose folder covers (== or is an ancestor of) the builder’s target folder AND whose filter: matches the projected record contributes: its default: / default_expr: fields layer in shallowest- folder first (deeper folders override), and the post-defaults record must satisfy all applicable collections — strict mode.

pub fn write_options(self, opts: WriteOptions) -> Self

pub fn fsync(self, yes: bool) -> Self

pub fn plan(&self, vault: &Vault) -> Result<MutationReport>

Compute the planned change without writing.

pub fn plan_with_content( &self, vault: &Vault, ) -> Result<(MutationReport, Option<String>)>

Plan and also return the file content that would be written. Used by the CLI’s --dry-run for create — the post-defaults frontmatter is the value of the preview.

pub fn execute(self, vault: &Vault) -> Result<MutationReport>

Plan, then write the file atomically. Holds the vault-scoped lock so concurrent creates against the same vault serialise cleanly.

Trait Implementations

impl Clone for CreateBuilder

fn clone(&self) -> CreateBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBuilder

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

Formats the value using the given formatter.