anki_bridge 0.10.2

AnkiBridge is a Rust library that provides a bridge between your Rust code and the Anki application, enabling HTTP communication and seamless data transmission.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

/*
* The MIT License (MIT)
*
* Copyright (c) 2023 Daniél Kerkmann <daniel@kerkmann.dev>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

/// Moves cards to a different deck.
///
/// If the deck does not exist, it is created.
pub mod change_deck;

/// Creates a new configuration group.
///
/// Can copy the default configuration group or a specific configuration group.
///
/// Returns the ID of the new configuration group, or `false` if the specified group to clone from does not exist.
pub mod clone_deck_config_id;

/// Creates a new deck.
///
/// The new deck will be empty.
///
/// Will not overwrite a deck that exists with the same name.
pub mod create_deck;

/// Gets the complete list of deck names and IDs for the current user.
pub mod deck_names_and_ids;

/// Gets the complete list of deck names for the current user.
pub mod deck_names;

/// Deletes decks with the given names.
///
/// The argument [`cards_too`] must be specified and set to `true`.
///
/// [`cards_too`]: delete_decks::DeleteDecksRequest::cards_too
pub mod delete_decks;

/// Gets the configuration group object for the given deck.
pub mod get_deck_config;

/// Gets statistics, such as total cards and cards due, for the given decks.
pub mod get_deck_stats;

/// Finds all decks a given a list of cards is part of.
///
/// Returns a dictionary where the key is the deck name and the value is a list of cards that belong to it.
pub mod get_decks;

/// Removes a configuration group.
///
/// Returns `true` if successful, or `false` if attempting to remove either the default configuration group (ID = 1) or a configuration group that does not exist.
pub mod remove_deck_config_id;

/// Saves a configuration group.
///
/// Returns `true` if successful, or `false` if the ID of the configuration group is invalid (such as when it does not exist).
pub mod save_deck_config;

/// Updates a configuration group for the given decks.
///
/// Returns `true` if successful, or `false` if the given configuration group or any of the given decks do not exist.
pub mod set_deck_config_id;