excelstream 0.20.2

High-performance streaming Excel & CSV library with S3/GCS cloud support and Parquet conversion - Ultra-low memory usage
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

//! Demonstrates worksheet protection features
//!
//! This example shows:
//! - Protecting worksheet with password
//! - Controlling what users can/cannot do
//! - Different protection levels

use excelstream::{CellStyle, CellValue, ExcelWriter, ProtectionOptions};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("Creating Excel file with worksheet protection...\n");

    let mut writer = ExcelWriter::new("worksheet_protection.xlsx")?;

    // ===== Sheet 1: Basic Protection with Password =====
    println!("Sheet 1: Basic protection with password");
    let protection = ProtectionOptions::new()
        .with_password("secret123")
        .allow_select_locked_cells(true)
        .allow_select_unlocked_cells(true);

    writer.protect_sheet(protection)?;

    writer.write_row_styled(&[(
        CellValue::String("Protected Sheet".to_string()),
        CellStyle::HeaderBold,
    )])?;
    writer.write_row([""])?;
    writer.write_row(["This sheet is protected with password: secret123"])?;
    writer.write_row(["Users can view but cannot edit without password"])?;

    // ===== Sheet 2: Read-Only Protection (No Password) =====
    writer.add_sheet("Read Only")?;
    println!("Sheet 2: Read-only protection (no password)");

    let protection = ProtectionOptions::new(); // No password
    writer.protect_sheet(protection)?;

    writer.write_row_styled(&[(
        CellValue::String("Read-Only Sheet".to_string()),
        CellStyle::HeaderBold,
    )])?;
    writer.write_row([""])?;
    writer.write_row(["This sheet is protected without password"])?;
    writer.write_row(["Users cannot edit, but can unprotect from Excel menu"])?;

    // ===== Sheet 3: Selective Permissions =====
    writer.add_sheet("Selective Permissions")?;
    println!("Sheet 3: Allow formatting but not inserting/deleting");

    let protection = ProtectionOptions::new()
        .with_password("format123")
        .allow_select_locked_cells(true)
        .allow_select_unlocked_cells(true)
        .allow_format_cells(true) // Allow formatting
        .allow_format_columns(true) // Allow column formatting
        .allow_format_rows(true); // Allow row formatting

    writer.protect_sheet(protection)?;

    writer.write_row_styled(&[(
        CellValue::String("Selective Permissions".to_string()),
        CellStyle::HeaderBold,
    )])?;
    writer.write_row([""])?;
    writer.write_row(["Password: format123"])?;
    writer.write_row(["Users CAN: Format cells, columns, rows"])?;
    writer.write_row(["Users CANNOT: Insert/delete rows/columns, edit cell values"])?;

    // ===== Sheet 4: Data Entry Sheet =====
    writer.add_sheet("Data Entry")?;
    println!("Sheet 4: Allow inserting rows for data entry");

    let protection = ProtectionOptions::new()
        .with_password("data456")
        .allow_select_locked_cells(true)
        .allow_select_unlocked_cells(true)
        .allow_insert_rows(true) // Allow inserting rows
        .allow_delete_rows(true) // Allow deleting rows
        .allow_sort(true); // Allow sorting

    writer.protect_sheet(protection)?;

    writer.write_row_styled(&[
        (CellValue::String("Name".to_string()), CellStyle::HeaderBold),
        (
            CellValue::String("Email".to_string()),
            CellStyle::HeaderBold,
        ),
        (
            CellValue::String("Phone".to_string()),
            CellStyle::HeaderBold,
        ),
    ])?;
    writer.write_row(["Alice", "alice@example.com", "555-0001"])?;
    writer.write_row(["Bob", "bob@example.com", "555-0002"])?;
    writer.write_row([""])?;
    writer.write_row(["Password: data456"])?;
    writer.write_row(["Users CAN: Insert/delete rows, sort data"])?;
    writer.write_row(["Users CANNOT: Edit header, insert/delete columns"])?;

    // ===== Sheet 5: No Protection (For Comparison) =====
    writer.add_sheet("No Protection")?;
    println!("Sheet 5: No protection (fully editable)");

    writer.write_row_styled(&[(
        CellValue::String("Unprotected Sheet".to_string()),
        CellStyle::HeaderBold,
    )])?;
    writer.write_row([""])?;
    writer.write_row(["This sheet has NO protection"])?;
    writer.write_row(["Users can edit anything"])?;

    writer.save()?;

    println!("\n✅ Created worksheet_protection.xlsx");
    println!("\nFeatures demonstrated:");
    println!("  1. Basic protection with password");
    println!("  2. Read-only protection without password");
    println!("  3. Selective permissions (formatting allowed)");
    println!("  4. Data entry protection (insert/delete rows allowed)");
    println!("  5. Unprotected sheet for comparison");
    println!("\nTry opening in Excel and testing different protection levels!");

    Ok(())
}