Enum tauri_utils::config::FsAllowlistScope

pub enum FsAllowlistScope {
    AllowedPaths(Vec<PathBuf>),
    Scope {
        allow: Vec<PathBuf>,
        deny: Vec<PathBuf>,
        require_literal_leading_dot: Option<bool>,
    },
}

Filesystem scope definition. It is a list of glob patterns that restrict the API access from the webview.

Each pattern can start with a variable that resolves to a system base directory. The variables are: $AUDIO, $CACHE, $CONFIG, $DATA, $LOCALDATA, $DESKTOP, $DOCUMENT, $DOWNLOAD, $EXE, $FONT, $HOME, $PICTURE, $PUBLIC, $RUNTIME, $TEMPLATE, $VIDEO, $RESOURCE, $APP, $LOG, $TEMP, $APPCONFIG, $APPDATA, $APPLOCALDATA, $APPCACHE, $APPLOG.

Variants

AllowedPaths(Vec<PathBuf>)

A list of paths that are allowed by this scope.

Scope

A complete scope configuration.

Fields

allow: Vec<PathBuf>

A list of paths that are allowed by this scope.

deny: Vec<PathBuf>

A list of paths that are not allowed by this scope. This gets precedence over the Self::Scope::allow list.

require_literal_leading_dot: Option<bool>

Whether or not paths that contain components that start with a . will require that . appears literally in the pattern; *, ?, **, or [...] will not match. This is useful because such files are conventionally considered hidden on Unix systems and it might be desirable to skip them when listing files.

Defaults to true on Unix systems and false on Windows

Implementations

impl FsAllowlistScope

pub fn allowed_paths(&self) -> &Vec<PathBuf>

The list of allowed paths.

pub fn forbidden_paths(&self) -> Option<&Vec<PathBuf>>

The list of forbidden paths.

Trait Implementations

impl Clone for FsAllowlistScope

fn clone(&self) -> FsAllowlistScope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FsAllowlistScope

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

Formats the value using the given formatter.

impl Default for FsAllowlistScope

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FsAllowlistScope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FsAllowlistScope

fn eq(&self, other: &FsAllowlistScope) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FsAllowlistScope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FsAllowlistScope

impl StructuralPartialEq for FsAllowlistScope