pub struct AgendaEngine<'a> { /* private fields */ }Implementations§
Source§impl<'a> AgendaEngine<'a>
impl<'a> AgendaEngine<'a>
pub fn new(index: &'a WorkspaceIndex) -> Self
pub fn agenda(&self, query: &AgendaQuery) -> Result<Vec<AgendaEntry>, AgdError>
pub fn todo( &self, match_expression: Option<&str>, today: NaiveDate, ) -> Result<Vec<Item>, AgdError>
Sourcepub fn inbox(&self) -> Vec<Item>
pub fn inbox(&self) -> Vec<Item>
The inbox: unfinished entries where captures land, in file and
buffer order. For each [[capture]] template (agent_inbox is one
of them) that is the direct children of its target heading
(heading, olpath or id), or the top-level entries of a
file it targets as a whole. A datetree target files entries by
date, a log rather than an inbox, so it is left out.
Every heading matching an Emacs tags match, done or not, like an
org-agenda tags block.
Source§impl<'a> AgendaEngine<'a>
impl<'a> AgendaEngine<'a>
Source§impl AgendaEngine<'_>
impl AgendaEngine<'_>
Sourcepub fn summary(
&self,
today: NaiveDate,
journal: &[JournalRecord],
) -> Result<AgendaSummary, AgdError>
pub fn summary( &self, today: NaiveDate, journal: &[JournalRecord], ) -> Result<AgendaSummary, AgdError>
The status band’s counts for today, with unreviewed agent changes
read from journal (WriteEngine::journal).
Source§impl<'a> AgendaEngine<'a>
impl<'a> AgendaEngine<'a>
Sourcepub fn view(
&self,
view: &ViewSettings,
start: NaiveDate,
today: NaiveDate,
log_mode: bool,
) -> Result<Vec<ViewSection>, AgdError>
pub fn view( &self, view: &ViewSettings, start: NaiveDate, today: NaiveDate, log_mode: bool, ) -> Result<Vec<ViewSection>, AgdError>
Runs a saved view block by block. start is the first agenda day
before span alignment, as for agd agenda --from.
Trait Implementations§
Source§impl<'a> Clone for AgendaEngine<'a>
impl<'a> Clone for AgendaEngine<'a>
Auto Trait Implementations§
impl<'a> Freeze for AgendaEngine<'a>
impl<'a> RefUnwindSafe for AgendaEngine<'a>
impl<'a> Send for AgendaEngine<'a>
impl<'a> Sync for AgendaEngine<'a>
impl<'a> Unpin for AgendaEngine<'a>
impl<'a> UnsafeUnpin for AgendaEngine<'a>
impl<'a> UnwindSafe for AgendaEngine<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more