Skip to main content

RenderInput

Struct RenderInput 

Source
pub struct RenderInput<'a> {
    pub date: &'a str,
    pub title: &'a str,
    pub why: &'a str,
    pub rejected: Option<&'a str>,
    pub risk: Option<&'a str>,
    pub tags: &'a [String],
}
Expand description

Inputs needed to render an entry block.

Kept as a borrow-everything struct so the call site reads cleanly and new optional fields can be added in future versions without breaking callers (they’d compile-error on the missing field and add None).

§Example

use logbook::{render_entry_block, RenderInput};

let tags = vec!["refactor".to_string()];
let block = render_entry_block(&RenderInput {
    date: "2026-05-16",
    title: "switched ORM",
    why: "perf",
    rejected: None,
    risk: None,
    tags: &tags,
});
assert!(block.starts_with("## 2026-05-16 — switched ORM\n"));

Fields§

§date: &'a str

Date string, conventionally YYYY-MM-DD. Not validated by the renderer — pass crate::today if you want today’s date.

§title: &'a str

Short single-line title.

§why: &'a str

The mandatory why field — the reason for the decision.

§rejected: Option<&'a str>

Optional rejected field — alternatives considered and why not. Empty or whitespace-only strings are omitted from the output.

§risk: Option<&'a str>

Optional risk field — what could go wrong. Empty or whitespace-only strings are omitted from the output.

§tags: &'a [String]

Tags to attach. Per-tag whitespace is trimmed and empty entries are dropped before rendering. An empty slice omits the tags line.

Trait Implementations§

Source§

impl<'a> Clone for RenderInput<'a>

Source§

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

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<'a> Debug for RenderInput<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for RenderInput<'a>

§

impl<'a> RefUnwindSafe for RenderInput<'a>

§

impl<'a> Send for RenderInput<'a>

§

impl<'a> Sync for RenderInput<'a>

§

impl<'a> Unpin for RenderInput<'a>

§

impl<'a> UnsafeUnpin for RenderInput<'a>

§

impl<'a> UnwindSafe for RenderInput<'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> 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.