Macro pseudo_directory

pseudo_directory!() { /* proc-macro */ }

Builds a pseudo directory using a simple DSL, potentially containing files and nested pseudo directories.

A directory is described using a sequence of rules of the following form:

=>

separated by commas, with an optional trailing comma.

It generates a nested pseudo directory, using directory::immutable::Simple::new() then adding all the specified entries in it, by calling crate::directory::helper::DirectlyMutable::add_entry.

Note: Names specified as literals (both str and [u8]) are compared during compilation time, so you should get a nice error message, if you specify the same entry name twice. As entry names can be specified as expressions, you can easily work around this check - you will still get an error, but it would be a panic! in this case. In any case the error message will contain details of the location of the generating macro and the duplicate entry name.

Examples

This will construct a small tree of read-only files:

let root = pseudo_directory! {
    "etc" => pseudo_directory! {
        "fstab" => read_only(b"/dev/fs /"),
        "passwd" => read_only(b"[redacted]"),
        "shells" => read_only(b"/bin/bash"),
        "ssh" => pseudo_directory! {
          "sshd_config" => read_only(b"# Empty"),
        },
    },
    "uname" => read_only(b"Fuchsia"),
};

See [//src/storage/lib/vfs/rust:vfs/src/lib.rs] for the documentation for this macro usage.