Struct FsPermissions

pub struct FsPermissions {
    pub permissions: Vec<PathPermission>,
}

Configures file system access

E.g. for cheat codes (vm.writeFile)

Fields

permissions: Vec<PathPermission>

what kind of access is allowed

Implementations

impl FsPermissions

pub fn new(permissions: impl IntoIterator<Item = PathPermission>) -> Self

Creates anew instance with the given permissions

pub fn add(&mut self, permission: PathPermission)

Adds a new permission

pub fn is_path_allowed(&self, path: &Path, kind: FsAccessKind) -> bool

Returns true if access to the specified path is allowed with the specified.

This first checks permission, and only if it is granted, whether the path is allowed.

We only allow paths that are inside allowed paths.

Caution: This should be called with normalized paths if the allowed_paths are also normalized.

pub fn find_permission(&self, path: &Path) -> Option<FsAccessPermission>

Returns the permission for the matching path.

This finds the longest matching path with resolved sym links, e.g. if we have the following permissions:

./out = read ./out/contracts = read-write

And we check for ./out/contracts/MyContract.sol we will get read-write as permission.

pub fn join_all(&mut self, root: &Path)

Updates all allowed_paths and joins (Path::join) the root with all entries

pub fn joined(self, root: &Path) -> Self

Same as Self::join_all but consumes the type

pub fn remove(&mut self, path: &Path)

Removes all existing permissions for the given path

pub fn is_empty(&self) -> bool

Returns true if no permissions are configured

pub fn len(&self) -> usize

Returns the number of configured permissions

Trait Implementations

impl Clone for FsPermissions

fn clone(&self) -> FsPermissions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FsPermissions

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

Formats the value using the given formatter.

impl Default for FsPermissions

fn default() -> FsPermissions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FsPermissions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FsPermissions

fn eq(&self, other: &FsPermissions) -> 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 FsPermissions

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 FsPermissions

impl StructuralPartialEq for FsPermissions

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes