Struct WriteProtection 

pub struct WriteProtection {
    pub read_only_recommended: bool,
    pub user_name: Option<String>,
    pub password: Option<String>,
}

Write-protection / “read-only recommended” (<fileSharing>, CT_FileSharing) — point 54, see Workbook::write_protection’s doc comment for how this differs from WorkbookProtection. Confirmed against sml.xsd: readOnlyRecommended defaults to false; userName is a plain display string (shown in Excel’s own “reserved by..” prompt); reservationPassword uses the same legacy 16-bit hash as WorkbookProtection/SheetProtection (see writer.rs::legacy_password_hash’s doc comment) — the newer SHA-512 algorithmName/hashValue/saltValue/spinCount form is not modeled, same “one well-defined mechanism” posture as ProtectedRange.

Fields

read_only_recommended: bool

Recommends opening the file as read-only (readOnlyRecommended) — the checkbox behind Excel’s Save As > Tools > General Options > “Read-only recommended”.

user_name: Option<String>

The name shown in Excel’s write-reservation prompt (userName), e.g. the name of the user who last saved with a reservation password set.

password: Option<String>

The write-reservation password, in plain text — hashed into the legacy 16-bit form on write, never recoverable on read (same one-way posture as WorkbookProtection::password). Excel prompts for this password (or “Read Only”) when opening the file.

Implementations

impl WriteProtection

pub fn recommended() -> WriteProtection

Recommends opening the file as read-only, no password/user name set.

Examples found in repository

examples/xlsx_protection.rs (line 33)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_protection.xlsx");

    let sheet_protection_sheet = Sheet::new("Sheet protection")
        .with_row(Row::new().with_text("Locked: this sheet is protected with a password."))
        .with_protection(SheetProtection::with_password("secret"));

    let protected_range_sheet = Sheet::new("Protected range")
        .with_row(
            Row::new()
                .with_text("A1 is protected; B1 stays editable via a named unprotected range."),
        )
        .with_protection(SheetProtection::locked())
        .with_protected_range(ProtectedRange::new("EditableArea", "B1:B1").with_password("secret"));

    let workbook = Workbook::new()
        .with_write_protection(
            WriteProtection::recommended()
                .with_user_name("Author")
                .with_password("secret"),
        )
        .with_sheet(sheet_protection_sheet)
        .with_sheet(protected_range_sheet);

    // `Workbook.protection` (structure protection: locking sheet
    // add/rename/hide/reorder/delete) has no `with_*` builder — it's set
    // directly, like any other public field.
    let workbook = Workbook {
        protection: Some(WorkbookProtection::locked().with_lock_windows(true)),
        ..workbook
    };

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_password(self, password: impl Into<String>) -> WriteProtection

Sets the write-reservation password and returns it for chaining.

Examples found in repository

examples/xlsx_protection.rs (line 35)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_protection.xlsx");

    let sheet_protection_sheet = Sheet::new("Sheet protection")
        .with_row(Row::new().with_text("Locked: this sheet is protected with a password."))
        .with_protection(SheetProtection::with_password("secret"));

    let protected_range_sheet = Sheet::new("Protected range")
        .with_row(
            Row::new()
                .with_text("A1 is protected; B1 stays editable via a named unprotected range."),
        )
        .with_protection(SheetProtection::locked())
        .with_protected_range(ProtectedRange::new("EditableArea", "B1:B1").with_password("secret"));

    let workbook = Workbook::new()
        .with_write_protection(
            WriteProtection::recommended()
                .with_user_name("Author")
                .with_password("secret"),
        )
        .with_sheet(sheet_protection_sheet)
        .with_sheet(protected_range_sheet);

    // `Workbook.protection` (structure protection: locking sheet
    // add/rename/hide/reorder/delete) has no `with_*` builder — it's set
    // directly, like any other public field.
    let workbook = Workbook {
        protection: Some(WorkbookProtection::locked().with_lock_windows(true)),
        ..workbook
    };

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_user_name(self, user_name: impl Into<String>) -> WriteProtection

Sets the user name shown in the write-reservation prompt and returns it for chaining.

Examples found in repository

examples/xlsx_protection.rs (line 34)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_protection.xlsx");

    let sheet_protection_sheet = Sheet::new("Sheet protection")
        .with_row(Row::new().with_text("Locked: this sheet is protected with a password."))
        .with_protection(SheetProtection::with_password("secret"));

    let protected_range_sheet = Sheet::new("Protected range")
        .with_row(
            Row::new()
                .with_text("A1 is protected; B1 stays editable via a named unprotected range."),
        )
        .with_protection(SheetProtection::locked())
        .with_protected_range(ProtectedRange::new("EditableArea", "B1:B1").with_password("secret"));

    let workbook = Workbook::new()
        .with_write_protection(
            WriteProtection::recommended()
                .with_user_name("Author")
                .with_password("secret"),
        )
        .with_sheet(sheet_protection_sheet)
        .with_sheet(protected_range_sheet);

    // `Workbook.protection` (structure protection: locking sheet
    // add/rename/hide/reorder/delete) has no `with_*` builder — it's set
    // directly, like any other public field.
    let workbook = Workbook {
        protection: Some(WorkbookProtection::locked().with_lock_windows(true)),
        ..workbook
    };

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

Trait Implementations

impl Clone for WriteProtection

fn clone(&self) -> WriteProtection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WriteProtection

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for WriteProtection

fn default() -> WriteProtection

Returns the “default value” for a type.

impl PartialEq for WriteProtection

fn eq(&self, other: &WriteProtection) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WriteProtection