Module

Node.FS.Perms

Package: purescript-node-fs
Repository: purescript-node/purescript-node-fs

#Perm Source

newtype Perm

A Perm value specifies what is allowed to be done with a particular file by a particular class of user — that is, whether it is readable, writable, and/or executable. It has a Semiring instance, which allows you to combine permissions:

(+) adds Perm values together. For example, read + write means "readable and writable".
(*) masks permissions. It can be thought of as selecting only the permissions that two Perm values have in common. For example: (read + write) * (write + execute) == write.

You can think also of a Perm value as a subset of the set { read, write, execute }; then, (+) and (*) represent set union and intersection respectively.

Instances

#mkPerm Source

mkPerm :: Boolean -> Boolean -> Boolean -> Perm

Create a Perm value. The arguments represent the readable, writable, and executable permissions, in that order.

#none Source

none :: Perm

No permissions. This is the identity of the Semiring operation (+) for Perm; that is, it is the same as zero.

#read Source

read :: Perm

The "readable" permission.

#write Source

write :: Perm

The "writable" permission.

#execute Source

execute :: Perm

The "executable" permission.

#all Source

all :: Perm

All permissions: readable, writable, and executable. This is the identity of the Semiring operation (*) for Perm; that is, it is the same as one.

#Perms Source

newtype Perms

A Perms value includes all the permissions information about a particular file or directory, by storing a Perm value for each of the file owner, the group, and any other users.

Instances

#mkPerms Source

mkPerms :: Perm -> Perm -> Perm -> Perms

Create a Perms value. The arguments represent the owner's, group's, and other users' permission sets, respectively.

#permsFromString Source

permsFromString :: String -> Maybe Perms

Attempt to parse a Perms value from a String containing an octal integer. For example, permsFromString "0644" == Just (mkPerms (read + write) read read).

#permsToString Source

permsToString :: Perms -> String

Convert a Perms value to an octal string, in a format similar to that accepted by chmod. For example: permsToString (mkPerms (read + write) read read) == "0644"

#permsToInt Source

permsToInt :: Perms -> Int

Convert a Perms value to an Int, via permsToString.

Modules: Node.FS; Node.FS.Async; Node.FS.Internal; Node.FS.Perms; Node.FS.Stats; Node.FS.Stream; Node.FS.Sync