Skip to main content

OrganizeEngine

Struct OrganizeEngine 

Source
pub struct OrganizeEngine<'a> { /* private fields */ }
Expand description

Organization workflow engine.

Implementations§

Source§

impl<'a> OrganizeEngine<'a>

Source

pub async fn clone_deck( &self, source: &str, destination: &str, ) -> Result<CloneReport>

Clone a deck with all its notes.

Creates a new deck with copies of all notes from the source deck. Scheduling information is not preserved (cards start as new).

§Arguments
  • source - Name of the deck to clone
  • destination - Name for the new deck
§Example
let engine = Engine::new();
let report = engine.organize().clone_deck("Japanese", "Japanese Copy").await?;
println!("Cloned {} notes", report.notes_cloned);
Source

pub async fn merge_decks( &self, sources: &[&str], destination: &str, ) -> Result<MergeReport>

Merge multiple decks into one.

Moves all cards from source decks into the destination deck. Does not delete the source decks.

§Arguments
  • sources - Names of decks to merge
  • destination - Name of the destination deck
§Example
let engine = Engine::new();
let report = engine.organize()
    .merge_decks(&["Deck A", "Deck B"], "Combined")
    .await?;
Source

pub async fn move_by_tag(&self, tag: &str, destination: &str) -> Result<usize>

Move notes matching a tag to a different deck.

§Arguments
  • tag - Tag to search for
  • destination - Deck to move matching notes to
§Example
let engine = Engine::new();
let moved = engine.organize()
    .move_by_tag("verb", "Japanese::Grammar::Verbs")
    .await?;
println!("Moved {} cards", moved);
Source

pub async fn reorganize_by_tags( &self, source_deck: &str, parent_deck: &str, tags: &[&str], ) -> Result<ReorganizeReport>

Reorganize cards by tag into subdecks.

For each unique tag, creates a subdeck under the parent deck and moves matching cards there.

§Arguments
  • source_deck - Deck to reorganize
  • parent_deck - Parent deck for new subdecks
  • tags - Tags to use for organization
§Example
let engine = Engine::new();
let report = engine.organize()
    .reorganize_by_tags("Japanese", "Japanese", &["verb", "noun", "adjective"])
    .await?;

Trait Implementations§

Source§

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

§

impl<'a> !RefUnwindSafe for OrganizeEngine<'a>

§

impl<'a> Send for OrganizeEngine<'a>

§

impl<'a> Sync for OrganizeEngine<'a>

§

impl<'a> Unpin for OrganizeEngine<'a>

§

impl<'a> !UnwindSafe for OrganizeEngine<'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> 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> PolicyExt for T
where T: ?Sized,

Source§

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

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