windows-file-enumeration-sys 0.1.1

Memory-safe asynchronous enumeration of one Windows directory with bounded submission and completion rings.
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

// Copyright (c) 2026 Mike Grier
//! Tests for the error taxonomy.

use super::*;
use std::error::Error as _;
use windows_sys::Win32::Foundation::ERROR_ACCESS_DENIED;

#[test]
fn a_win32_code_round_trips_through_io_error() {
    let code = Win32Error::from_code(ERROR_ACCESS_DENIED);
    assert_eq!(code.code(), ERROR_ACCESS_DENIED);
    assert_eq!(
        code.to_io_error().raw_os_error(),
        Some(ERROR_ACCESS_DENIED as i32)
    );
    assert_eq!(Win32Error::from_io(&code.to_io_error()), code);
}

#[test]
fn an_io_error_without_an_os_code_becomes_zero() {
    let fabricated = io::Error::other("no OS error behind this");
    assert_eq!(Win32Error::from_io(&fabricated).code(), 0);
}

#[test]
fn a_win32_code_displays_with_its_numeric_value() {
    let rendered = Win32Error::from_code(2).to_string();
    assert!(rendered.contains('2'), "{rendered}");
}

#[test]
fn a_request_error_without_a_call_behind_it_carries_no_code() {
    let error = RequestError::new(RequestFailure::EmptyPath);
    assert_eq!(error.failure(), RequestFailure::EmptyPath);
    assert_eq!(error.code(), None);
    assert!(!error.to_string().is_empty());
}

#[test]
fn a_resolution_failure_keeps_the_code_windows_reported() {
    let error = RequestError::with_code(RequestFailure::PathResolution, Win32Error::from_code(123));
    assert_eq!(error.code(), Some(Win32Error::from_code(123)));
    assert!(error.to_string().contains("123"));
}

#[test]
fn a_predicate_error_names_which_clause_was_vacuous() {
    for failure in [
        PredicateFailure::EmptyAttributeMask,
        PredicateFailure::EmptyNameSet,
    ] {
        let error = PredicateError::new(failure);
        assert_eq!(error.failure(), failure);
        assert!(!error.to_string().is_empty());
    }
}

#[test]
fn every_native_enumeration_failure_keeps_its_raw_code() {
    let code = Win32Error::from_code(87);
    let cases = [
        EnumerationError::DirectoryOpen(code),
        EnumerationError::VolumeIdentity(code),
        EnumerationError::UnsupportedExtendedDirectoryInfo(code),
        EnumerationError::DirectoryQuery(code),
        EnumerationError::RecordTooLarge {
            buffer_capacity: 1024,
            code,
        },
    ];
    for error in cases {
        assert_eq!(error.code(), Some(code), "{error:?}");
        assert!(!error.to_string().is_empty());
    }
}

#[test]
fn an_oversize_record_reports_the_capacity_it_did_not_fit() {
    let error = EnumerationError::RecordTooLarge {
        buffer_capacity: 4096,
        code: Win32Error::from_code(234),
    };
    assert!(error.to_string().contains("4096"), "{error}");
}

#[test]
fn every_malformed_record_reason_describes_itself() {
    let cases = [
        MalformedRecord::Alignment,
        MalformedRecord::TruncatedFixedFields,
        MalformedRecord::NextEntryOffset,
        MalformedRecord::OddNameLength,
        MalformedRecord::NameOutOfBounds,
        MalformedRecord::NegativeSize,
    ];
    for detail in cases {
        let error = EnumerationError::MalformedRecord(detail);
        assert!(!error.to_string().is_empty(), "{detail:?}");
        assert_eq!(error.code(), None);
        assert!(error.source().is_none());
    }
}

#[test]
fn a_native_failure_has_no_nested_source() {
    // The raw code is the whole story for a last-error API, so there is nothing
    // to chain to.
    let error = EnumerationError::DirectoryOpen(Win32Error::from_code(3));
    assert!(error.source().is_none());
}