Serde2File

serialize some data to a file or deserialize a data from a file by serde_json

1. Support:

• Encrypted storage is supported when storing files
• Support user-defined encryption method and parameter transfer
• Provide default aes256gsm encryption implementation

1. derive macro FileSerializeAndDeserialize Attributes（Optional）:

• fileencrypt
  • encrypt Data encryption method
  • decrypt Data decryption method
  • The above encryption and decryption methods must be set at the same time, otherwise encryption and decryption will not be performed.
  • #[fileencrypt(encrypt="TestEncryptTool::encrypt",decrypt="TestEncryptTool::decrypt")]
• dumpfilename
  • Custom dump file name
  • If not set ,the default dump file name is the full name of the current Struct.
  • For example, the default dump file name corresponding to serde2file::test::TestData is serde2file-test-TestData.json
  • #[dumpfilename = "test_data.json"]
• encryptextraargtype
  • Define additional encryption and decryption parameter types
  • Used to pass custom parameters to encryption or decryption functions
  • #[encryptextraargtype = "&'static str"]

将struct序列化化存储为文件，或者从文件反序列化为struct

===

1. 支持：

• 文件存储时支持加密存储
• 支持自定义加密方法和参数传递
• 提供默认的aes256gsm加密实现

1. 派生宏FileSerializeAndDeserialize属性(可选)

• fileencrypt
  • encrypt 数据加密方法
  • decrypt 数据解密方法
  • 以上加密和解密方法必须同时设置，否则不进行加解密。
  • #[fileencrypt(encrypt="TestEncryptTool::encrypt",decrypt="TestEncryptTool::decrypt")]
• dumpfilename
  • 设置自定义的转储文件名称
  • 自定义转储文件名称
  • 如未设置,默认为当前Struct的完整名称，
  • 如serde2file::test::TestData对应的缺省转储文件名称为serde2file-test-TestData.json
  • #[dumpfilename = "test_data.json"]
• encryptextraargtype
  • 定义额外的加解密参数类型
  • 用于向加密或解密函数传递自定义参数使用
  • #[encryptextraargtype = "&'static str"]

1. Example1 / 示例1

(1) Simplest use / 最简单用法

Without encryption, dump the struct directly to a json file. The dump file name is the default name

无需加密，直接将struct转储到json文件,转储文件名称为默认名称

```rust use serde::{Deserialize, Serialize}; use serde2file::prelude::*;

[derive(Debug, Serialize, Deserialize, Default, PartialEq, Eq, FileSerializeAndDeserialize)]

struct TestData { id: String, name: String, }

cfg(test)

mod test { use super::*; /// Test serialization and encrypted storage to file /// 测试序列化并加密存储到文件 #[test] fn testserializetofile() { let data = TestData { id: "01".into(), name: "hy".into(), }; asserteq!("/tmp/[package-name]-Test-Data.json",data.dumptofile("/tmp").unwrap()); } /// Test deserialization from encrypted file /// 测试从加密文件反序列化 #[test] fn testdeserializefromfile() { let data = TestData { id: "01".into(), name: "hy".into(), }; let sdata = TestData::loadfromfile("/tmp").unwrap(); asserteq!(data, sdata) } } ```

(2) Encrypted dump to custom file / 加密转储为自定义文件

Encrypt the dump file. The default aes256gsm encryption is used for encryption.
No additional encryption parameters are required.
Set the dump file name to test_ data.json.

加密转储文件，加密时使用默认的aes256gsm加密实现，无需额外加密参数,设置转储文件名称为test_data.json.

```rust use serde::{Deserialize, Serialize}; use serde2file::encrypt::Aes256GcmEncryptUtil; use serde2file::prelude::*;

[allow(dead_code)]

[derive(Debug, Serialize, Deserialize, Default, PartialEq, Eq, FileSerializeAndDeserialize)]

[file_encrypt(encrypt = "TestEncryptTool::encrypt", decrypt = "TestEncryptTool::decrypt")]

[dumpfilename = "test_data.json"]

struct TestData { id: String, name: String, } /// a encryption and decryption tools

[allow(dead_code)]

struct TestEncryptTool; impl Aes256GcmEncryptUtil for TestEncryptTool{ type EncryptExtraArgType = (); fn getaeskeynonce(extra:Option) -> (String, String) { ( format!("*)#@{}!$=^20230208)leb*$xz",extra.unwrapor("140600")), "abc$hy%95599".into(), ) } }

/// Test serialization and encrypted storage to file /// 测试序列化并加密存储到文件

[test]

fn testserdefile() { let data = TestData { id: "01".into(), name: "hy".into(), }; asserteq!("/tmp/testdata.json",data.dumptofile("/tmp").unwrap()); let sdata = TestData::loadfromfile("/tmp").unwrap(); asserteq!(data, s_data) }

```

(3) 自定义加密参数加密转储文件

The default aes256gsm encryption is used for encryption, and additional encryption and decryption parameters are required. Set the dump file name to test_ data.json.

加密时使用默认的aes256gsm加密实现，并需要额外加解密参数,设置转储文件名称为test_data.json

```rust use serde::{Deserialize, Serialize}; use super::encrypt::Aes256GcmEncryptUtil;

use crate::prelude::*;

[allow(dead_code)]

[derive(Debug, Serialize, Deserialize, Default, PartialEq, Eq, FileSerializeAndDeserialize)]

[file_encrypt(encrypt = "TestEncryptTool::encrypt", decrypt = "TestEncryptTool::decrypt")]

[encryptextraarg_type = "&'static str"]

[dumpfilename = "test_data2.json"]

struct TestData2 { id: String, name: String, }

/// a encryption and decryption tools

[allow(dead_code)]

struct TestEncryptTool; impl Aes256GcmEncryptUtil for TestEncryptTool{ type EncryptExtraArgType = &'static str; fn getaeskeynonce(extra:Option) -> (String, String) { ( format!("*)#@{}!$=^20230208)leb*$xz",extra.unwrapor("140600")), "abc$hy%95599".into(), ) } }

/// Test serialization and encrypted storage to file with extra param /// 测试序列化并加密存储到文件

[test]

fn testserdefileextra2() { let data = TestData2 { id: "01".into(), name: "hy".into(), }; asserteq!("/tmp/testdata2.json",data.dumptofileextra("/tmp",Some("14H701")).unwrap()); let sdata = TestData2::loadfromfileextra("/tmp",Some("14H701")).unwrap(); asserteq!(data, sdata) }

/// Test serialization and encrypted storage to file /// 测试序列化并加密存储到文件

[test]

fn testserdefile2() { let data = TestData2 { id: "01".into(), name: "hy".into(), }; asserteq!("/tmp/testdata2.json",data.dumptofile("/tmp").unwrap()); let sdata = TestData2::loadfromfile("/tmp").unwrap(); asserteq!(data, s_data) }

```