os-bridge 0.1.4

A cross platform API bridge based on Rust language
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
82
83
84

extern crate walkdir;
extern crate zip;

use std::{fs::File, path::Path};
use zip::ZipWriter;

use crate::BridgeResult;

/// OsBridge
pub trait OsBridge {
  fn get_pid(&self) -> BridgeResult<u32>;
}

/// zip
pub trait Zip {
  ///  Calculate file size
  fn calculate_size<P>(&self, path: P) -> BridgeResult<f64>
  where
    P: AsRef<Path>;

  /// Read file size
  fn get_size<P>(&self, path: P) -> u64
  where
    P: AsRef<Path>;

  /// @description:  Decompression extractor
  /// @parama zip_src_path: Decompression target path
  /// @parama zip_output_path: Output Path
  fn extract<P>(&self, zip_src_path: P, zip_output_path: P) -> BridgeResult<bool>
  where
    P: AsRef<Path>;

  /// @description:  Single file compression
  /// @parama zip_input_path: Compression target path
  /// @parama zip_output_path: Output Path
  fn file_compression<P>(&self, zip_input_path: P, zip_output_path: P) -> BridgeResult<bool>
  where
    P: AsRef<Path>;

  /// @description:  Single folder compression
  /// @parama zip_input_path: Compression target path
  /// @parama zip_output_path: Output Path
  fn single_folder_compression<P>(
    &self,
    zip_input_path: P,
    zip_output_path: P,
  ) -> BridgeResult<bool>
  where
    P: AsRef<Path>;

  /// @description:  Add directory
  /// @parama zip_writer: ZipWriter
  /// @parama base_dir: Directory path
  /// @parama current_dir: Base directory
  fn add_dir<P>(
    &self,
    zip_writer: &mut ZipWriter<File>,
    base_dir: P,
    current_dir: P,
  ) -> BridgeResult<bool>
  where
    P: AsRef<Path>;

  /// batch compression
  /// Please provide a list path
  /// @parama zip_input_paths: [zip_input_path1, zip_input_path2, ...]
  /// @parama zip_output_path: Output Path
  fn batch_compression<P>(&self, zip_input_paths: Vec<P>, zip_output_path: P) -> BridgeResult<bool>
  where
    P: AsRef<Path>;

  /// @description Check whether the folder is empty
  /// @parama path: Path
  fn check_folder_is_empty<P>(&self, path: P) -> BridgeResult<bool>
  where
    P: AsRef<Path>;

  /// @description: Add a path to the zip file
  /// @parama zip_writer: zip_writer
  /// @parama path: Path
  fn add_path<P>(&self, zip_writer: &mut ZipWriter<File>, path: P) -> BridgeResult<bool>
  where
    P: AsRef<Path>;
}