class System::User

Overview

Represents a user on the host system.

NOTE To use User, you must explicitly import it with require "system/user"

Users can be retrieved by either username or their user ID:

require "system/user"

System::User.find_by name: "root"
System::User.find_by id: "0"

Extended Modules

Defined in:

system/user.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from class Reference

==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, initialize initialize, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Class methods inherited from class Object

from_json(string_or_io, root : String)
from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml

Class Method Detail

def self.find_by(*, name : String) : System::User #

Returns the user associated with the given username.

Raises NotFoundError if no such user exists.


[View source]
def self.find_by(*, id : String) : System::User #

Returns the user associated with the given ID.

Raises NotFoundError if no such user exists.


[View source]
def self.find_by?(*, name : String) : System::User | Nil #

Returns the user associated with the given username.

Returns nil if no such user exists.


[View source]
def self.find_by?(*, id : String) : System::User | Nil #

Returns the user associated with the given ID.

Returns nil if no such user exists.


[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def group_id : String #

The user's primary group identifier.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def home_directory : String #

The user's home directory.


[View source]
def id : String #

The user's identifier.


[View source]
def name : String #

The user's real or full name.

May not be present on all platforms. Returns the same value as #username if neither a real nor full name is available.


[View source]
def shell : String #

The user's login shell.


[View source]
def to_s(io) #

[View source]
def username : String #

The user's username.


[View source]