Skip to main content

CreationContext

Struct CreationContext 

Source
pub struct CreationContext<'a> {
    pub title: String,
    pub type_name: String,
    pub config: &'a ResolvedConfig,
    pub typedef: Option<Arc<TypeDefinition>>,
    pub registry: &'a TypeRegistry,
    pub vars: HashMap<String, String>,
    pub core_metadata: CoreMetadata,
    pub output_path: Option<PathBuf>,
    pub template: Option<LoadedTemplate>,
    pub batch_mode: bool,
    pub reference_date: Option<NaiveDate>,
}
Expand description

Context available during note creation.

Fields§

§title: String§type_name: String§config: &'a ResolvedConfig§typedef: Option<Arc<TypeDefinition>>§registry: &'a TypeRegistry§vars: HashMap<String, String>§core_metadata: CoreMetadata§output_path: Option<PathBuf>§template: Option<LoadedTemplate>§batch_mode: bool§reference_date: Option<NaiveDate>

Implementations§

Source§

impl<'a> CreationContext<'a>

Source

pub fn new( type_name: &str, title: &str, config: &'a ResolvedConfig, registry: &'a TypeRegistry, ) -> Self

Create a new creation context.

Source

pub fn with_vars(self, cli_vars: HashMap<String, String>) -> Self

Add CLI-provided variables.

Source

pub fn with_template(self, template: LoadedTemplate) -> Self

Set a template to use for content generation.

Source

pub fn with_batch_mode(self, batch: bool) -> Self

Set batch mode flag.

Source

pub fn get_var(&self, key: &str) -> Option<&str>

Get a variable value.

Source

pub fn set_var(&mut self, key: impl Into<String>, value: impl Into<String>)

Set a variable value.

Source

pub fn to_prompt_context(&self) -> PromptContext<'_>

Create a PromptContext from this CreationContext.

Auto Trait Implementations§

§

impl<'a> Freeze for CreationContext<'a>

§

impl<'a> RefUnwindSafe for CreationContext<'a>

§

impl<'a> Send for CreationContext<'a>

§

impl<'a> Sync for CreationContext<'a>

§

impl<'a> Unpin for CreationContext<'a>

§

impl<'a> UnsafeUnpin for CreationContext<'a>

§

impl<'a> UnwindSafe for CreationContext<'a>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> MaybeSend for T