anki/rslib/src/prelude.rs

// Copyright: Ankitects Pty Ltd and contributors
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html

pub use crate::{
    card::{Card, CardId},
    collection::Collection,
    config::BoolKey,
    deckconf::{DeckConf, DeckConfId},
    decks::{Deck, DeckId, DeckKind},
    error::{AnkiError, Result},
    i18n::I18n,
    notes::{Note, NoteId},
    notetype::{Notetype, NotetypeId},
    ops::{Op, OpChanges, OpOutput},
    revlog::RevlogId,
    timestamp::{TimestampMillis, TimestampSecs},
    types::Usn,
};
pub use slog::{debug, Logger};
start on HTTP client for syncing 2020-05-26 09:18:50 +02:00			`// Copyright: Ankitects Pty Ltd and contributors`
			`// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html`

			`pub use crate::{`
use mixed case for abbreviations in Rust code So, this is fun. Apparently "DeckId" is considered preferable to the "DeckID" were were using until now, and the latest clippy will start warning about it. We could of course disable the warning, but probably better to bite the bullet and switch to the naming that's generally considered best. 2021-03-27 10:53:33 +01:00			`card::{Card, CardId},`
note deletion undo; refactoring - transact() now automatically clears card queues unless an op opts-out (and currently only AnswerCard does). This means there's no risk of forgetting to clear the queues in an operation, or when undoing/ redoing - CollectionOp->UndoableOp - clear queues when redoing "answer card", instead of clearing redo when clearing queues 2021-03-05 10:09:08 +01:00			`collection::Collection,`
use native boolkey instead of separate getters/setters Makes it easier to add new config settings in the future, especially if we don't need to export them via protobuf. 2021-03-07 14:43:18 +01:00			`config::BoolKey,`
use mixed case for abbreviations in Rust code So, this is fun. Apparently "DeckId" is considered preferable to the "DeckID" were were using until now, and the latest clippy will start warning about it. We could of course disable the warning, but probably better to bite the bullet and switch to the naming that's generally considered best. 2021-03-27 10:53:33 +01:00			`deckconf::{DeckConf, DeckConfId},`
			`decks::{Deck, DeckId, DeckKind},`
crate::err -> crate::error 2021-04-01 08:06:24 +02:00			`error::{AnkiError, Result},`
drop the legacy enum from rslib, and pass separate module/message idx 2021-03-27 02:56:31 +01:00			`i18n::I18n,`
use mixed case for abbreviations in Rust code So, this is fun. Apparently "DeckId" is considered preferable to the "DeckID" were were using until now, and the latest clippy will start warning about it. We could of course disable the warning, but probably better to bite the bullet and switch to the naming that's generally considered best. 2021-03-27 10:53:33 +01:00			`notes::{Note, NoteId},`
switch NoteType to Notetype When used as a variable, we were typically calling it a 'notetype', not a 'note type'. 2021-03-27 13:03:19 +01:00			`notetype::{Notetype, NotetypeId},`
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead 2021-03-16 05:26:42 +01:00			`ops::{Op, OpChanges, OpOutput},`
use mixed case for abbreviations in Rust code So, this is fun. Apparently "DeckId" is considered preferable to the "DeckID" were were using until now, and the latest clippy will start warning about it. We could of course disable the warning, but probably better to bite the bullet and switch to the naming that's generally considered best. 2021-03-27 10:53:33 +01:00			`revlog::RevlogId,`
start on HTTP client for syncing 2020-05-26 09:18:50 +02:00			`timestamp::{TimestampMillis, TimestampSecs},`
			`types::Usn,`
			`};`
			`pub use slog::{debug, Logger};`