github.com/greenpau/go-authcrunch@v1.1.4/pkg/authn/enums/role/role.go (about)

     1  // Copyright 2024 Paul Greenberg greenpau@outlook.com
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package role
    16  
    17  import (
    18  	"fmt"
    19  )
    20  
    21  // Kind is the type of a role.
    22  type Kind int
    23  
    24  const (
    25  	// Unknown operator signals invalid role type.
    26  	Unknown Kind = iota
    27  	// Anonymous indicates anonymous.
    28  	Anonymous
    29  	// Admin indicates role with administrative privileges.
    30  	Admin
    31  	// User indicates role with user privileges.
    32  	User
    33  	// Guest indicates role with guest privileges.
    34  	Guest
    35  )
    36  
    37  // String returns string representation of a role type.
    38  func (e Kind) String() string {
    39  	switch e {
    40  	case Unknown:
    41  		return "Unknown"
    42  	case Anonymous:
    43  		return "Anonymous"
    44  	case Admin:
    45  		return "Admin"
    46  	case User:
    47  		return "User"
    48  	case Guest:
    49  		return "Guest"
    50  	}
    51  	return fmt.Sprintf("RoleKind(%d)", int(e))
    52  }