Struct OpenOptions 

pub struct OpenOptions { /* private fields */ }

Options to open a file with path-traversal protection.

Mirrors the access-mode setters of [tokio::fs::OpenOptions] (read/write/append/truncate/create/create_new) and adds jail to confine every opened path to a trusted root directory.

Lexical traversal protection (rejecting .., reserved device names and smuggled prefixes) is always applied. jail additionally rejects absolute paths and resolves symlinks against the root so they cannot escape it.

Implementations

impl OpenOptions

pub fn new() -> OpenOptions

Create a new set of options with every flag disabled, matching [tokio::fs::OpenOptions::new]. Enable at least one access mode (e.g. read) before calling open.

pub fn read(&mut self, read: bool) -> &mut OpenOptions

Set the option for read access.

pub fn write(&mut self, write: bool) -> &mut OpenOptions

Set the option for write access.

pub fn append(&mut self, append: bool) -> &mut OpenOptions

Set the option for append mode.

pub fn truncate(&mut self, truncate: bool) -> &mut OpenOptions

Set the option for truncating a previous file.

pub fn create(&mut self, create: bool) -> &mut OpenOptions

Set the option to create a new file, or open it if it already exists.

pub fn create_new(&mut self, create_new: bool) -> &mut OpenOptions

Set the option to create a new file, failing if it already exists.

pub fn jail(&mut self, root: impl Into<PathBuf>) -> &mut OpenOptions

Confine every opened path to within root.

The path passed to open is then interpreted as relative to root; absolute paths are rejected, and the resolved path (with symlinks followed) must remain within root or the open fails with UnsafePathError::EscapesRoot. root must exist when opening.

pub fn symlinks(&mut self, policy: SymlinkPolicy) -> &mut OpenOptions

Set how symbolic links are treated within the jail root.

Defaults to SymlinkPolicy::RestrictToRoot. Has no effect unless a jail root is configured.

pub async fn open(&self, path: impl AsRef<Path>) -> Result<File, Error>

Open the file at path with the configured options, after validating it against path-traversal attacks.

Trait Implementations

impl Clone for OpenOptions

fn clone(&self) -> OpenOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenOptions

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

Formats the value using the given formatter.

impl Default for OpenOptions

fn default() -> OpenOptions

Returns the “default value” for a type.