std::fs::Permissions - Rust
Description: API documentation for the Rust `Permissions` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, Permissions

# 1.0.0[−][src]Struct std::fs::Permissions

    pub struct Permissions(_);

Representation of the various permissions on a file.

This module only currently provides one bit of information, `readonly`, which is exposed on all currently supported platforms. Unix-specific functionality, such as mode bits, is available through the `PermissionsExt` trait.

## Methods

### `impl Permissions`[src]

#### `pub fn readonly(&self) -> bool`[src]

Returns `true` if these permissions describe a readonly (unwritable) file.

# Examples

    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let mut f = File::create("foo.txt")?;
        let metadata = f.metadata()?;

        assert_eq!(false, metadata.permissions().readonly());
        Ok(())
    }

Run

#### `pub fn set_readonly(&mut self, readonly: bool)`[src]

Modifies the readonly flag for this set of permissions. If the `readonly` argument is `true`, using the resulting `Permission` will update file permissions to forbid writing. Conversely, if it's `false`, using the resulting `Permission` will update file permissions to allow writing.

This operation does not modify the filesystem. To modify the filesystem use the `fs::set_permissions` function.

# Examples

    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let f = File::create("foo.txt")?;
        let metadata = f.metadata()?;
        let mut permissions = metadata.permissions();

        permissions.set_readonly(true);

        // filesystem doesn't change
        assert_eq!(false, metadata.permissions().readonly());

        // just this particular `permissions`.
        assert_eq!(true, permissions.readonly());
        Ok(())
    }

Run

## Trait Implementations

### `impl Clone for Permissions`[src]

#### `fn clone(&self) -> Permissions`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`[src]

Performs copy-assignment from `source`. Read more

### `impl Debug for Permissions`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl Eq for Permissions`[src]

### `impl PartialEq<Permissions> for Permissions`[src]

#### `fn eq(&self, other: &Permissions) -> bool`[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, other: &Permissions) -> bool`[src]

This method tests for `!=`.

### `impl PermissionsExt for Permissions` 1.1.0[src]

#### `fn mode(&self) -> u32`[src]

This is supported on Unix only.

Returns the underlying raw `st_mode` bits that contain the standard Unix permissions for this file. Read more

#### `fn set_mode(&mut self, mode: u32)`[src]

This is supported on Unix only.

Sets the underlying raw bits for this set of permissions. Read more

#### `fn from_mode(mode: u32) -> Permissions`[src]

This is supported on Unix only.

Creates a new instance of `Permissions` from the given set of Unix permission bits. Read more

### `impl StructuralEq for Permissions`[src]

### `impl StructuralPartialEq for Permissions`[src]

## Auto Trait Implementations

### `impl RefUnwindSafe for Permissions`

### `impl Send for Permissions`

### `impl Sync for Permissions`

### `impl Unpin for Permissions`

### `impl UnwindSafe for Permissions`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.