Skip to main content

OrgMode

Struct OrgMode 

Source
pub struct OrgMode { /* private fields */ }

Implementations§

Source§

impl OrgMode

Source

pub fn new(config: OrgConfig) -> Result<Self, OrgModeError>

Source

pub fn with_defaults() -> Result<Self, OrgModeError>

Source

pub fn config(&self) -> &OrgConfig

Source§

impl OrgMode

Source

pub fn list_files( &self, tags: Option<&[String]>, limit: Option<usize>, ) -> Result<Vec<String>, OrgModeError>

Source

pub fn search( &self, query: &str, limit: Option<usize>, snippet_max_size: Option<usize>, ) -> Result<Vec<SearchResult>, OrgModeError>

Source

pub fn search_with_tags( &self, query: &str, tags: Option<&[String]>, limit: Option<usize>, snippet_max_size: Option<usize>, ) -> Result<Vec<SearchResult>, OrgModeError>

Source

pub fn list_files_by_tags( &self, tags: &[String], ) -> Result<Vec<String>, OrgModeError>

Source

pub fn read_file(&self, path: &str) -> Result<String, OrgModeError>

Source

pub fn get_outline(&self, path: &str) -> Result<TreeNode, OrgModeError>

Source

pub fn get_heading( &self, path: &str, heading: &str, ) -> Result<String, OrgModeError>

Source

pub fn get_element_by_id(&self, id: &str) -> Result<String, OrgModeError>

Source

pub fn list_tasks( &self, todo_states: Option<&[String]>, tags: Option<&[String]>, priority: Option<Priority>, limit: Option<usize>, ) -> Result<Vec<AgendaItem>, OrgModeError>

List all tasks (TODO/DONE items) across all org files

§Arguments
  • todo_states - Optional filter for specific TODO states (e.g., [“TODO”, “DONE”])
  • tags - Optional filter by tags
  • priority - Optional filter by priority level
  • limit - Maximum number of items to return
§Returns

Vector of AgendaItem containing task information

Source

pub fn get_agenda_view( &self, agenda_view_type: AgendaViewType, todo_states: Option<&[String]>, tags: Option<&[String]>, ) -> Result<AgendaView, OrgModeError>

Get agenda view organized by date

§Arguments
  • agenda_view_type - Type of agenda view (e.g., Today, CurrentWeek, Custom range)
  • todo_states - Optional filter for specific TODO states
  • tags - Optional filter by tags
§Returns

AgendaView containing items within the date range

Source

pub fn start_to_chrono(ts: &Timestamp) -> Option<NaiveDateTime>

Source

pub fn end_to_chrono(ts: &Timestamp) -> Option<NaiveDateTime>

Trait Implementations§

Source§

impl Debug for OrgMode

Source§

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

Formats the value using the given formatter. 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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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