Skip to main content

ClockReportProvider

Struct ClockReportProvider 

Source
pub struct ClockReportProvider { /* private fields */ }
Expand description

Renders a ClockReport as virtual rows above line 0 of a scan view.

Display-only, and that is the design (org-agenda.md §3): a clock report has no source range and nothing to jump to, which is exactly what VirtualRow models. The cost — you cannot put the cursor on a report line — is stated in the design rather than discovered here; making those lines actionable means excerpts over a synthetic pathless source, which is deferred.

Implementations§

Source§

impl ClockReportProvider

Source

pub fn new( view: BufferId, state: Arc<RwLock<ScanViewState>>, days: RangeInclusive<i64>, ) -> Self

Unthemed — the rows paint with the renderer’s default foreground. Test convenience; production goes through Self::with_theme.

Source

pub fn with_theme( view: BufferId, state: Arc<RwLock<ScanViewState>>, days: RangeInclusive<i64>, theme: ThemeRegistryHandle, elements: ClockReportElementIds, ) -> Self

The production constructor: colours resolve from the registry on every collect(), and the resolved theme’s version rides in version(), so a :colorscheme swap re-paints the report instead of leaving it in the previous palette.

Source

pub fn set_days(&self, days: RangeInclusive<i64>)

Re-point the report at a different range — what gD’s day/week/month toggles change. Bumps the version so the rows rebuild.

Source

pub fn lines(&self) -> Vec<String>

The report as lines of text, which is what both the renderer and the tests want — splitting this out keeps the row-building testable without a theme or a worker.

Trait Implementations§

Source§

impl Debug for ClockReportProvider

Source§

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

Formats the value using the given formatter. Read more
Source§

impl VirtualRowProvider for ClockReportProvider

Source§

fn id(&self) -> u64

A stable id for this provider. Used by the worker to deduplicate registration + route mutation notifications.
Source§

fn version(&self) -> u64

Monotonic version counter — the provider bumps it whenever the rows [Self::collect] would emit have changed. The worker uses the combined fingerprint of all providers’ versions to short-circuit on the cache-hit path without paying for the (potentially expensive) collect calls. Read more
Source§

fn collect(&self) -> Vec<VirtualRow>

Emit the current set of virtual rows for the associated document. 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.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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