Search code examples
c#permissionsenumsflags

Why do enum permissions often have 0, 1, 2, 4 values?


Why are people always using enum values like 0, 1, 2, 4, 8 and not 0, 1, 2, 3, 4?

Has this something to do with bit operations, etc.?

I would really appreciate a small sample snippet on how this is used correctly :)

[Flags]
public enum Permissions
{
    None   = 0,
    Read   = 1,
    Write  = 2,
    Delete = 4
}

Solution

  • Because they are powers of two and I can do this:

    var permissions = Permissions.Read | Permissions.Write;
    

    And perhaps later...

    if( (permissions & Permissions.Write) == Permissions.Write )
    {
        // we have write access
    }
    

    It is a bit field, where each set bit corresponds to some permission (or whatever the enumerated value logically corresponds to). If these were defined as 1, 2, 3, ... you would not be able to use bitwise operators in this fashion and get meaningful results. To delve deeper...

    Permissions.Read   == 1 == 00000001
    Permissions.Write  == 2 == 00000010
    Permissions.Delete == 4 == 00000100
    

    Notice a pattern here? Now if we take my original example, i.e.,

    var permissions = Permissions.Read | Permissions.Write;
    

    Then...

    permissions == 00000011
    

    See? Both the Read and Write bits are set, and I can check that independently (Also notice that the Delete bit is not set and therefore this value does not convey permission to delete).

    It allows one to store multiple flags in a single field of bits.