PosixPermissions

fs2.io.file.PosixPermissions
See thePosixPermissions companion object
final class PosixPermissions extends Permissions

Describes POSIX file permissions, where the user, group, and others are each assigned read, write, and/or execute permissions.

The toString method provides a 9 character string where the first three characters indicate user permissions, the next three group permissions, and the final three others permissions. For example, rwxr-xr-- indicates the owner has read, write and execute, the group as read and execute, and others have read.

The value field encodes the permissions in the lowest 9 bits of an integer. bits 8-6 indicate read, write, and execute for the owner, 5-3 for the group, and 2-0 for others. rwxr-xr-- has the integer value 111101100 = 492.

The toOctalString method returns the a 3 digit string, where the first character indicates read, write and execute for the owner, the second digit for the group, and the third digit for others. rwxr-xr-- has the octal string 754.

Constructors from strings, octal strings, and integers, as well as explicitly enumerating permissions, are provided in the companion.

Attributes

Companion:
object
Source:
Permissions.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Attributes

that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
Source:
Permissions.scala
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns:

the hash code value for this object.

Definition Classes
Any
Source:
Permissions.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Definition Classes
Any
Source:
Permissions.scala

Concrete fields

val value: Int

Attributes

Source:
Permissions.scala