Struct OpenOptions 

pub struct OpenOptions { /* private fields */ }

Available on crate feature std only.

Options to open a file with async 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.

Implementations

impl OpenOptions

pub fn new() -> Self

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 Self

Set the option for read access.

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

Set the option for write access.

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

Set the option for append mode.

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

Set the option for truncating a previous file.

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

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 Self

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

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

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 must remain within root or the open fails with UnsafePathError::EscapesRoot. root must exist when opening.

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

Set how symbolic links are treated within the jail root.

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

pub fn created_file_permissions( &mut self, permissions: CreatedFilePermissions, ) -> &mut Self

Set permissions used when this open operation creates a new file.

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

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) -> Self

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

Formats the value using the given formatter.

impl Default for OpenOptions

fn default() -> Self

Returns the “default value” for a type.