Skip to main content

StudyReport

ankit_engine::analyze

Struct StudyReport

pub struct StudyReport {Show 16 fields
    pub deck: String,
    pub period_days: u32,
    pub total_reviews: usize,
    pub total_time_minutes: u64,
    pub average_reviews_per_day: f64,
    pub study_streak: u32,
    pub retention_rate: f64,
    pub average_ease: f64,
    pub new_cards_studied: usize,
    pub review_cards_studied: usize,
    pub relearning_cards: usize,
    pub leeches: Vec<i64>,
    pub low_ease_cards: Vec<i64>,
    pub due_tomorrow: usize,
    pub due_this_week: usize,
    pub daily_stats: Vec<ReportDailyStats>,
}

Expand description

Comprehensive study report combining multiple statistics.

Provides a complete overview of study activity, performance, problem areas, and upcoming workload for a deck over a specified time period.

Fields§

§deck: String

The deck name (or “*” for all decks).

§period_days: u32

Number of days covered by this report.

§total_reviews: usize

Total number of reviews in the period.

§total_time_minutes: u64

Total time spent studying in minutes.

§average_reviews_per_day: f64

Average reviews per day.

§study_streak: u32

Consecutive days with at least one review.

§retention_rate: f64

Estimated retention rate (0.0 - 1.0).

§average_ease: f64

Average ease factor (percentage * 10, e.g., 2500 = 250%).

§new_cards_studied: usize

Number of new cards studied in the period.

§review_cards_studied: usize

Number of review cards studied in the period.

§relearning_cards: usize

Number of cards in relearning state.

§leeches: Vec<i64>

Card IDs flagged as leeches (high lapses).

§low_ease_cards: Vec<i64>

Card IDs with low ease factor (below 200%).

§due_tomorrow: usize

Number of cards due tomorrow.

§due_this_week: usize

Number of cards due within the next 7 days.

§daily_stats: Vec<ReportDailyStats>

Statistics for each day in the period.

Trait Implementations§

impl Clone for StudyReport

fn clone(&self) -> StudyReport

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for StudyReport

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

Formats the value using the given formatter. Read more

impl Default for StudyReport

fn default() -> StudyReport

Returns the “default value” for a type. Read more

impl Serialize for StudyReport

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for StudyReport

impl RefUnwindSafe for StudyReport

impl Send for StudyReport

impl Sync for StudyReport

impl Unpin for StudyReport

impl UnwindSafe for StudyReport

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

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

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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