uefi 0.40.0

This crate makes it easy to develop Rust software that leverages safe, convenient, and performant abstractions for UEFI functionality.
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

// SPDX-License-Identifier: MIT OR Apache-2.0

//! This module offers the [`Path`] and [`PathBuf`] abstractions.
//!
//! # Interoperability with Rust Strings
//!
//! To use Rust strings - `String` and `str` - with this API, first convert them
//! to [`CString16`] or [`CStr16`]. Rust strings do not directly convert to
//! [`Path`] or [`PathBuf`].
//!
//! # Path Structure
//!
//! Paths use the [`SEPARATOR`] character as separator. Paths are absolute and
//! do not contain `.` or `..` components. However, this can be implemented in
//! the future.
//!
//! [`CString16`]: uefi::data_types::CString16

mod path;
mod pathbuf;
mod validation;

pub use path::{Components, Path};
pub use pathbuf::PathBuf;

use crate::data_types::chars::NUL_16;
use crate::{CStr16, Char16, char16, cstr16};
pub use validation::PathError;
pub(super) use validation::validate_path;

/// The default separator for paths.
pub const SEPARATOR: Char16 = char16!('\\');

/// Stringified version of [`SEPARATOR`].
pub const SEPARATOR_STR: &CStr16 = cstr16!("\\");

/// Deny list of characters for path components. UEFI supports FAT-like file
/// systems. According to <https://en.wikipedia.org/wiki/Comparison_of_file_systems>,
/// paths should not contain these symbols.
pub const CHARACTER_DENY_LIST: [Char16; 10] = {
    [
        NUL_16,
        char16!('"'),
        char16!('*'),
        char16!('/'),
        char16!(':'),
        char16!('<'),
        char16!('>'),
        char16!('?'),
        SEPARATOR,
        char16!('|'),
    ]
};