rsdoc 0.3.0

Transform PlandUML/Drawio diagrams in doc comments as PNG images.
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

use clap::Parser;
use std::fs::{self, File};
use std::path::Path;
use std::time::Duration;

use deflate::deflate_bytes;

#[derive(Parser, Debug)]
#[clap(version, about, long_about = None)]
struct Args {
    #[clap(help = "URL of the file to download")]
    url: String,
    #[clap(short, long, help = "Output filename")]
    output: Option<String>,
}

fn create_output_file(output_filename: &str) -> Result<File, String> {
    let output_file_path = Path::new(output_filename);

    // never overwrite the output file
    if output_file_path.exists() {
        return Err(format!(
            "output file {} already exists, aborting...",
            output_filename
        ));
    }

    match File::create(output_file_path) {
        Ok(file) => Ok(file),
        Err(e) => Err(format!(
            "failed to open file {} for writing; cause: {}",
            output_filename, e
        )),
    }
}

fn save_png(url:&str, output_filename:&str) -> bool{
    let _ = fs::remove_file(output_filename);

    let output_file_ret = create_output_file(&output_filename);
    if let Ok(mut output_file) = output_file_ret{
        let agent = ureq::AgentBuilder::new()
        .timeout_read(Duration::from_secs(5))
        .timeout_write(Duration::from_secs(5))
        .build();

        let response = match agent.get(&url).call() {
            Ok(response) => response,
            Err(_) => {
                fs::remove_file(output_filename).unwrap();
                return false;
            }
        };

        match std::io::copy(&mut response.into_reader(), &mut output_file) {
            Ok(_) => (),
            Err(_) => {
                fs::remove_file(output_filename).unwrap();
                return false;
            }
        }   
    }
    return true;
}

pub fn encode64_(e:&[u8]) -> String{
    let mut r = String::new();

    for i in (0..e.len()).step_by(3)
    {
        if i+2==e.len(){
            r.push_str(append3bytes(e[i],e[i+1],0).as_str());
        }
        else
        {
            if i+1==e.len(){
                r.push_str(append3bytes(e[i],0,0).as_str());
            }
            else{
                r.push_str(append3bytes(e[i],e[i+1],e[i+2]).as_str());
            }
        }
    }
    r
}
    
fn append3bytes(e:u8,n:u8,t:u8) -> String
{
    let c1=e>>2;
    let c2=(3&e)<<4|n>>4;
    let c3 =(15&n)<<2|t>>6;
    let c4 =63&t;
    let mut r = String::new();
    r.push(encode6bit(63&c1));
    r.push(encode6bit(63&c2));
    r.push(encode6bit(63&c3));
    r.push(encode6bit(63&c4));  
    r
}
fn encode6bit(e1:u8) -> char{
    let mut e = e1;
    if e<10 {
        return char::from_u32( (e + 48) as u32).unwrap();
    }
    else{
        e -= 10;
        if e <26{
            return char::from_u32((65+e) as u32).unwrap();
        } 
        else{
            e -= 26;
            if e < 26{
                return char::from_u32((97+e) as u32).unwrap();
            }
            else{
                e -= 26;
                if 0== e{
                    return '-';
                }
                else{
                    if 1==e{
                        return '_';
                    }
                    else{
                        return '?';
                    }
                }
            }
        }
    }
}

pub fn download_puml(puml_str: &str, png_save_path_name:&str) -> bool
{
    //If the file_name encoded by sha1 still exists, it means that the UML code has not been modified, so return true directly
    if Path::new(&png_save_path_name).exists(){
        return true;
    }
    let path = std::path::Path::new(png_save_path_name);
    let prefix = path.parent().unwrap();
    std::fs::create_dir_all(prefix).unwrap();

    let compressed = deflate_bytes(puml_str.as_bytes());
    let encode64_str = encode64_(&compressed);
    let url = "http://www.plantuml.com/plantuml/png/".to_string() + &encode64_str;
  

    
    save_png(&url, png_save_path_name)
}

// pub fn download_puml(puml_str: &str, png_save_path_name: &str) -> bool {
//     // If the file_name encoded by sha1 still exists, it means that the UML code has not been modified, so return true directly
//     if Path::new(png_save_path_name).exists() {
//         return true;
//     }

//     let path = std::path::Path::new(png_save_path_name);
//     let prefix = path.parent().unwrap();
    
//     if let Err(err) = std::fs::create_dir_all(prefix) {
//         eprintln!("Failed to create directory: {}", err);
//         return false;
//     }
//     else{
//         eprintln!("OKOKOK: ");
//     }

//     let compressed = deflate_bytes(puml_str.as_bytes());
//     let encode64_str = encode64_(&compressed);
//     let url = "http://www.plantuml.com/plantuml/png/".to_string() + &encode64_str;

//     save_png(&url, png_save_path_name)
// }