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
/*
* The MIT License (MIT)
*
* Copyright (c) 2025 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.
*/

use serde::Serialize;

use crate::AnkiRequest;

/// Parameters for the "getMediaFilesNames" action.
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize)]
pub struct GetMediaFilesNamesRequest {
    /// Filename pattern.
    ///
    /// Leave `None` to get all files in the media directory.
    ///
    /// Use an asterisk (\*) as a wildcard character. For example, "h*llo.txt" will match files
    /// named "hello.txt", "hallo.txt" and "heeello.txt".
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pattern: Option<String>,
}

impl AnkiRequest for GetMediaFilesNamesRequest {
    type Response = Vec<String>;

    const ACTION: &'static str = "getMediaFilesNames";
    const VERSION: u8 = 6;
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_serialize() {
        let request = GetMediaFilesNamesRequest {
            pattern: Some("_hell*.txt".to_string()),
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(
            json,
            r#"{
  "pattern": "_hell*.txt"
}"#
        );
    }

    #[test]
    fn test_serialize_no_pattern() {
        let request = GetMediaFilesNamesRequest {
            ..Default::default()
        };

        let json = serde_json::to_string_pretty(&request).unwrap();
        assert_eq!(json, "{}");
    }

    #[test]
    fn test_deserialize() {
        let json = r#"["_hello.txt", "_hallo.txt", "_heeello.txt"]"#;
        let response: <GetMediaFilesNamesRequest as AnkiRequest>::Response =
            serde_json::from_str(json).unwrap();

        assert_eq!(
            response,
            vec![
                "_hello.txt".to_string(),
                "_hallo.txt".to_string(),
                "_heeello.txt".to_string()
            ]
        );
    }
}