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

    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 `os::unix::PermissionsExt` trait.

## Methods

###

`impl Permissions`

[src]

####

`pub fn readonly(&self) -> bool`

[src]

Returns whether 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 PartialEq 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 Eq for Permissions`

[src]

###

`impl Debug for Permissions`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`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

## Auto Trait Implementations

###

`impl Send for Permissions`

###

`impl Sync for Permissions`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)