static VALUEs_absolute_path(int c, const VALUE * v, VALUE _){    return rb_file_s_absolute_path(c, v);}

Converts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process unlessdir_string is given, in which case it will be used as the starting point. If the given pathname starts with a “~” it is NOT expanded, it is treated as a normal directory name.

File.absolute_path("~oracle/bin")#=> "<relative_path>/~oracle/bin"

static VALUEs_absolute_path_p(VALUE klass, VALUE fname){    VALUE path = rb_get_path(fname);    if (!rb_is_absolute_path(RSTRING_PTR(path))) return Qfalse;    return Qtrue;}

Returnstrue iffile_name is an absolute path, andfalse otherwise.

File.absolute_path?("c:/foo")#=> false (on Linux), true (on Windows)

static VALUErb_file_s_atime(VALUE klass, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) {        int e = errno;        FilePathValue(fname);        rb_syserr_fail_path(e, fname);    }    return stat_time(stat_atimespec(&st));}

Returns the last access time for the named file as aTime object.

file_name can be anIO object.

File.atime("testfile")#=> Wed Apr 09 08:51:48 CDT 2003

static VALUErb_file_s_basename(int argc, VALUE *argv, VALUE _){    VALUE fname, fext, basename;    const char *name, *p;    long f, n;    rb_encoding *enc;    fext = Qnil;    if (rb_check_arity(argc, 1, 2) == 2) {        fext = argv[1];        StringValue(fext);        enc = check_path_encoding(fext);    }    fname = argv[0];    FilePathStringValue(fname);    if (NIL_P(fext) || !(enc = rb_enc_compatible(fname, fext))) {        enc = rb_enc_get(fname);        fext = Qnil;    }    if ((n = RSTRING_LEN(fname)) == 0 || !*(name = RSTRING_PTR(fname)))        return rb_str_new_shared(fname);    p = ruby_enc_find_basename(name, &f, &n, enc);    if (n >= 0) {        if (NIL_P(fext)) {            f = n;        }        else {            const char *fp;            fp = StringValueCStr(fext);            if (!(f = rmext(p, f, n, fp, RSTRING_LEN(fext), enc))) {                f = n;            }            RB_GC_GUARD(fext);        }        if (f == RSTRING_LEN(fname)) return rb_str_new_shared(fname);    }    basename = rb_str_new(p, f);    rb_enc_copy(basename, fname);    return basename;}

Returns the last component of the filename given infile_name (after first stripping trailing separators), which can be formed using bothFile::SEPARATOR andFile::ALT_SEPARATOR as the separator whenFile::ALT_SEPARATOR is notnil. Ifsuffix is given and present at the end offile_name, it is removed. Ifsuffix is “.*”, any extension will be removed.

File.basename("/home/gumby/work/ruby.rb")#=> "ruby.rb"File.basename("/home/gumby/work/ruby.rb",".rb")#=> "ruby"File.basename("/home/gumby/work/ruby.rb",".*")#=> "ruby"

VALUErb_file_s_birthtime(VALUE klass, VALUE fname){    rb_io_stat_data st;    if (rb_statx(fname, &st, STATX_BTIME) < 0) {        int e = errno;        FilePathValue(fname);        rb_syserr_fail_path(e, fname);    }    return statx_birthtime(&st);}

Returns the birth time for the named file.

file_name can be anIO object.

File.birthtime("testfile")#=> Wed Apr 09 08:53:13 CDT 2003

If the platform doesn’t have birthtime, raisesNotImplementedError.

static VALUErb_file_blockdev_p(VALUE obj, VALUE fname){#ifndef S_ISBLK#   ifdef S_IFBLK#       define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)#   else#       define S_ISBLK(m) (0)  /* anytime false */#   endif#endif#ifdef S_ISBLK    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    if (S_ISBLK(st.st_mode)) return Qtrue;#endif    return Qfalse;}

Returnstrue iffilepath points to a block device,false otherwise:

File.blockdev?('/dev/sda1')# => trueFile.blockdev?(File.new('t.tmp'))# => false

static VALUErb_file_chardev_p(VALUE obj, VALUE fname){#ifndef S_ISCHR#   define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)#endif    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    if (S_ISCHR(st.st_mode)) return Qtrue;    return Qfalse;}

Returnstrue iffilepath points to a character device,false otherwise.

File.chardev?($stdin)# => trueFile.chardev?('t.txt')# => false

static VALUErb_file_s_chmod(int argc, VALUE *argv, VALUE _){    mode_t mode;    apply2args(1);    mode = NUM2MODET(*argv++);    return apply2files(chmod_internal, argc, argv, &mode);}

Changes permission bits on the named file(s) to the bit pattern represented bymode_int. Actual effects are operating system dependent (see the beginning of this section). On Unix systems, seechmod(2) for details. Returns the number of files processed.

File.chmod(0644,"testfile","out")#=> 2

static VALUErb_file_s_chown(int argc, VALUE *argv, VALUE _){    struct chown_args arg;    apply2args(2);    arg.owner = to_uid(*argv++);    arg.group = to_gid(*argv++);    return apply2files(chown_internal, argc, argv, &arg);}

Changes the owner and group of the named file(s) to the given numeric owner and group id’s. Only a process with superuser privileges may change the owner of a file. The current owner of a file may change the file’s group to any group to which the owner belongs. Anil or -1 owner or group id is ignored. Returns the number of files processed.

File.chown(nil,100,"testfile")

static VALUErb_file_s_ctime(VALUE klass, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) {        int e = errno;        FilePathValue(fname);        rb_syserr_fail_path(e, fname);    }    return stat_time(stat_ctimespec(&st));}

Returns the change time for the named file (the time at which directory information about the file was changed, not the file itself).

file_name can be anIO object.

Note that on Windows (NTFS), returns creation time (birth time).

File.ctime("testfile")#=> Wed Apr 09 08:53:13 CDT 2003

static VALUErb_file_s_unlink(int argc, VALUE *argv, VALUE klass){    return apply2files(unlink_internal, argc, argv, 0);}

Deletes the named files, returning the number of names passed as arguments. Raises an exception on any error. Since the underlying implementation relies on theunlink(2) system call, the type of exception raised depends on its error type (seelinux.die.net/man/2/unlink) and has the form of e.g. Errno::ENOENT.

See alsoDir::rmdir.

VALUErb_file_directory_p(VALUE obj, VALUE fname){#ifndef S_ISDIR#   define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)#endif    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    if (S_ISDIR(st.st_mode)) return Qtrue;    return Qfalse;}

With stringobject given, returnstrue ifpath is a string path leading to a directory, or to a symbolic link to a directory;false otherwise:

File.directory?('.')# => trueFile.directory?('foo')# => falseFile.symlink('.','dirlink')# => 0File.directory?('dirlink')# => trueFile.symlink('t,txt','filelink')# => 0File.directory?('filelink')# => false

Argumentpath can be anIO object.

static VALUErb_file_s_dirname(int argc, VALUE *argv, VALUE klass){    int n = 1;    if ((argc = rb_check_arity(argc, 1, 2)) > 1) {        n = NUM2INT(argv[1]);    }    return rb_file_dirname_n(argv[0], n);}

Returns all components of the filename given infile_name except the last one (after first stripping trailing separators). The filename can be formed using bothFile::SEPARATOR andFile::ALT_SEPARATOR as the separator whenFile::ALT_SEPARATOR is notnil.

File.dirname("/home/gumby/work/ruby.rb")#=> "/home/gumby/work"

Iflevel is given, removes the lastlevel components, not only one.

File.dirname("/home/gumby/work/ruby.rb",2)#=> "/home/gumby"File.dirname("/home/gumby/work/ruby.rb",4)#=> "/"

static VALUErb_file_zero_p(VALUE obj, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    return RBOOL(st.st_size == 0);}

Returnstrue if the named file exists and has a zero size.

file_name can be anIO object.

static VALUErb_file_executable_p(VALUE obj, VALUE fname){    return RBOOL(rb_eaccess(fname, X_OK) >= 0);}

Returnstrue if the named file is executable by the effective user and group id of this process. See eaccess(3).

Windows does not support execute permissions separately from read permissions. On Windows, a file is only considered executable if it ends in .bat, .cmd, .com, or .exe.

Note that some OS-level security features may cause this to return true even though the file is not executable by the effective user/group.

static VALUErb_file_executable_real_p(VALUE obj, VALUE fname){    return RBOOL(rb_access(fname, X_OK) >= 0);}

Returnstrue if the named file is executable by the real user and group id of this process. See access(3).

Windows does not support execute permissions separately from read permissions. On Windows, a file is only considered executable if it ends in .bat, .cmd, .com, or .exe.

Note that some OS-level security features may cause this to return true even though the file is not executable by the real user/group.

static VALUErb_file_exist_p(VALUE obj, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    return Qtrue;}

Returntrue if the named file exists.

file_name can be anIO object.

“file exists” means that stat() or fstat() system call is successful.

static VALUEs_expand_path(int c, const VALUE * v, VALUE _){    return rb_file_s_expand_path(c, v);}

Converts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process unlessdir_string is given, in which case it will be used as the starting point. The given pathname may start with a “~”, which expands to the process owner’s home directory (the environment variableHOME must be set correctly). “~user” expands to the named user’s home directory.

File.expand_path("~oracle/bin")#=> "/home/oracle/bin"

A simple example of usingdir_string is as follows.

File.expand_path("ruby","/usr/bin")#=> "/usr/bin/ruby"

A more complex example which also resolves parent directory is as follows. Suppose we are in bin/mygem and want the absolute path of lib/mygem.rb.

File.expand_path("../../lib/mygem.rb",__FILE__)#=> ".../path/to/project/lib/mygem.rb"

So first it resolves the parent of __FILE__, that is bin/, then go to the parent, the root of the project and appendslib/mygem.rb.

static VALUErb_file_s_extname(VALUE klass, VALUE fname){    const char *name, *e;    long len;    VALUE extname;    FilePathStringValue(fname);    name = StringValueCStr(fname);    len = RSTRING_LEN(fname);    e = ruby_enc_find_extname(name, &len, rb_enc_get(fname));    if (len < 1)        return rb_str_new(0, 0);    extname = rb_str_subseq(fname, e - name, len); /* keep the dot, too! */    return extname;}

Returns the extension (the portion of file name inpath starting from the last period).

Ifpath is a dotfile, or starts with a period, then the starting dot is not dealt with the start of the extension.

An empty string will also be returned when the period is the last character inpath.

On Windows, trailing dots are truncated.

File.extname("test.rb")#=> ".rb"File.extname("a/b/d/test.rb")#=> ".rb"File.extname(".a/b/d/test.rb")#=> ".rb"File.extname("foo.")#=> "" on WindowsFile.extname("foo.")#=> "." on non-WindowsFile.extname("test")#=> ""File.extname(".profile")#=> ""File.extname(".profile.sh")#=> ".sh"

static VALUErb_file_file_p(VALUE obj, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    return RBOOL(S_ISREG(st.st_mode));}

Returnstrue if the namedfile exists and is a regular file.

file can be anIO object.

If thefile argument is a symbolic link, it will resolve the symbolic link and use the file referenced by the link.

# File dir.rb, line 503deffnmatch(pattern,path,flags =0)end

Returns true ifpath matches againstpattern. The pattern is not a regular expression; instead it follows rules similar to shell filename globbing. It may contain the following metacharacters:

*

Matches any file. Can be restricted by other values in the glob. Equivalent to/.*/x in regexp.

*

Matches all regular files

c*

Matches all files beginning withc

*c

Matches all files ending withc

*c*

Matches all files that havec in them (including at the beginning or end).

To match hidden files (that start with a.) set the File::FNM_DOTMATCH flag.

**

Matches directories recursively or files expansively.

?

Matches any one character. Equivalent to/.{1}/ in regexp.

[set]

Matches any one character inset. Behaves exactly like character sets inRegexp, including set negation ([^a-z]).

\

Escapes the next metacharacter.

{a,b}

Matches pattern a and pattern b if File::FNM_EXTGLOB flag is enabled. Behaves like aRegexp union ((?:a|b)).

flags is a bitwise OR of theFNM_XXX constants. The same glob pattern and flags are used byDir::glob.

Examples:

File.fnmatch('cat','cat')#=> true  # match entire stringFile.fnmatch('cat','category')#=> false # only match partial stringFile.fnmatch('c{at,ub}s','cats')#=> false # { } isn't supported by defaultFile.fnmatch('c{at,ub}s','cats',File::FNM_EXTGLOB)#=> true  # { } is supported on FNM_EXTGLOBFile.fnmatch('c?t','cat')#=> true  # '?' match only 1 characterFile.fnmatch('c??t','cat')#=> false # dittoFile.fnmatch('c*','cats')#=> true  # '*' match 0 or more charactersFile.fnmatch('c*t','c/a/b/t')#=> true  # dittoFile.fnmatch('ca[a-z]','cat')#=> true  # inclusive bracket expressionFile.fnmatch('ca[^t]','cat')#=> false # exclusive bracket expression ('^' or '!')File.fnmatch('cat','CAT')#=> false # case sensitiveFile.fnmatch('cat','CAT',File::FNM_CASEFOLD)#=> true  # case insensitiveFile.fnmatch('cat','CAT',File::FNM_SYSCASE)#=> true or false # depends on the system defaultFile.fnmatch('?','/',File::FNM_PATHNAME)#=> false # wildcard doesn't match '/' on FNM_PATHNAMEFile.fnmatch('*','/',File::FNM_PATHNAME)#=> false # dittoFile.fnmatch('[/]','/',File::FNM_PATHNAME)#=> false # dittoFile.fnmatch('\?','?')#=> true  # escaped wildcard becomes ordinaryFile.fnmatch('\a','a')#=> true  # escaped ordinary remains ordinaryFile.fnmatch('\a','\a',File::FNM_NOESCAPE)#=> true  # FNM_NOESCAPE makes '\' ordinaryFile.fnmatch('[\?]','?')#=> true  # can escape inside bracket expressionFile.fnmatch('*','.profile')#=> false # wildcard doesn't match leadingFile.fnmatch('*','.profile',File::FNM_DOTMATCH)#=> true  # period by default.File.fnmatch('.*','.profile')#=> trueFile.fnmatch('**/*.rb','main.rb')#=> falseFile.fnmatch('**/*.rb','./main.rb')#=> falseFile.fnmatch('**/*.rb','lib/song.rb')#=> trueFile.fnmatch('**.rb','main.rb')#=> trueFile.fnmatch('**.rb','./main.rb')#=> falseFile.fnmatch('**.rb','lib/song.rb')#=> trueFile.fnmatch('*','dave/.profile')#=> trueFile.fnmatch('**/foo','a/b/c/foo',File::FNM_PATHNAME)#=> trueFile.fnmatch('**/foo','/a/b/c/foo',File::FNM_PATHNAME)#=> trueFile.fnmatch('**/foo','c:/a/b/c/foo',File::FNM_PATHNAME)#=> trueFile.fnmatch('**/foo','a/.b/c/foo',File::FNM_PATHNAME)#=> falseFile.fnmatch('**/foo','a/.b/c/foo',File::FNM_PATHNAME|File::FNM_DOTMATCH)#=> true

static VALUErb_file_s_ftype(VALUE klass, VALUE fname){    struct stat st;    FilePathValue(fname);    fname = rb_str_encode_ospath(fname);    if (lstat_without_gvl(StringValueCStr(fname), &st) == -1) {        rb_sys_fail_path(fname);    }    return rb_file_ftype(st.st_mode);}

Identifies the type of the named file; the return string is one of “file”, “directory”, “characterSpecial”, “blockSpecial”, “fifo”, “link”, “socket”, or “unknown”.

File.ftype("testfile")#=> "file"File.ftype("/dev/tty")#=> "characterSpecial"File.ftype("/tmp/.X11-unix/X0")#=> "socket"

static VALUErb_file_grpowned_p(VALUE obj, VALUE fname){#ifndef _WIN32    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    if (rb_group_member(st.st_gid)) return Qtrue;#endif    return Qfalse;}

Returnstrue if the named file exists and the effective group id of the calling process is the owner of the file. Returnsfalse on Windows.

file_name can be anIO object.

static VALUErb_file_identical_p(VALUE obj, VALUE fname1, VALUE fname2){#ifndef _WIN32    struct stat st1, st2;    if (rb_stat(fname1, &st1) < 0) return Qfalse;    if (rb_stat(fname2, &st2) < 0) return Qfalse;    if (st1.st_dev != st2.st_dev) return Qfalse;    if (st1.st_ino != st2.st_ino) return Qfalse;    return Qtrue;#else    extern VALUE rb_w32_file_identical_p(VALUE, VALUE);    return rb_w32_file_identical_p(fname1, fname2);#endif}

Returnstrue if the named files are identical.

file_1 andfile_2 can be anIO object.

open("a","w") {}pFile.identical?("a","a")#=> truepFile.identical?("a","./a")#=> trueFile.link("a","b")pFile.identical?("a","b")#=> trueFile.symlink("a","c")pFile.identical?("a","c")#=> trueopen("d","w") {}pFile.identical?("a","d")#=> false

static VALUErb_file_s_join(VALUE klass, VALUE args){    return rb_file_join(args);}

Returns a new string formed by joining the strings using"/".

File.join("usr","mail","gumby")#=> "usr/mail/gumby"

static VALUErb_file_s_lchmod(int argc, VALUE *argv, VALUE _){    mode_t mode;    apply2args(1);    mode = NUM2MODET(*argv++);    return apply2files(lchmod_internal, argc, argv, &mode);}

Equivalent toFile::chmod, but does not follow symbolic links (so it will change the permissions associated with the link, not the file referenced by the link). Often not available.

static VALUErb_file_s_lchown(int argc, VALUE *argv, VALUE _){    struct chown_args arg;    apply2args(2);    arg.owner = to_uid(*argv++);    arg.group = to_gid(*argv++);    return apply2files(lchown_internal, argc, argv, &arg);}

Equivalent toFile::chown, but does not follow symbolic links (so it will change the owner associated with the link, not the file referenced by the link). Often not available. Returns number of files in the argument list.

static VALUErb_file_s_link(VALUE klass, VALUE from, VALUE to){    FilePathValue(from);    FilePathValue(to);    from = rb_str_encode_ospath(from);    to = rb_str_encode_ospath(to);    if (link(StringValueCStr(from), StringValueCStr(to)) < 0) {        sys_fail2(from, to);    }    return INT2FIX(0);}

Creates a new name for an existing file using a hard link. Will not overwritenew_name if it already exists (raising a subclass ofSystemCallError). Not available on all platforms.

File.link("testfile",".testfile")#=> 0IO.readlines(".testfile")[0]#=> "This is line one\n"

static VALUErb_file_s_lstat(VALUE klass, VALUE fname){#ifdef HAVE_LSTAT    rb_io_stat_data st;    FilePathValue(fname);    fname = rb_str_encode_ospath(fname);    if (lstatx_without_gvl(StringValueCStr(fname), &st, STATX_ALL) == -1) {        rb_sys_fail_path(fname);    }    return rb_statx_new(&st);#else    return rb_file_s_stat(klass, fname);#endif}

LikeFile::stat, but does not follow the last symbolic link; instead, returns aFile::Stat object for the link itself.

File.symlink('t.txt','symlink')File.stat('symlink').size# => 47File.lstat('symlink').size# => 5

static VALUErb_file_s_lutime(int argc, VALUE *argv, VALUE _){    return utime_internal_i(argc, argv, TRUE);}

Sets the access and modification times of each named file to the first two arguments. If a file is a symlink, this method acts upon the link itself as opposed to its referent; for the inverse behavior, seeFile.utime. Returns the number of file names in the argument list.

static VALUErb_file_s_mkfifo(int argc, VALUE *argv, VALUE _){    VALUE path;    struct mkfifo_arg ma;    ma.mode = 0666;    rb_check_arity(argc, 1, 2);    if (argc > 1) {        ma.mode = NUM2MODET(argv[1]);    }    path = argv[0];    FilePathValue(path);    path = rb_str_encode_ospath(path);    ma.path = RSTRING_PTR(path);    if (IO_WITHOUT_GVL(nogvl_mkfifo, &ma)) {        rb_sys_fail_path(path);    }    return INT2FIX(0);}

Creates a FIFO special file with namefile_name.mode specifies the FIFO’s permissions. It is modified by the process’s umask in the usual way: the permissions of the created file are (mode & ~umask).

static VALUErb_file_s_mtime(VALUE klass, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) {        int e = errno;        FilePathValue(fname);        rb_syserr_fail_path(e, fname);    }    return stat_time(stat_mtimespec(&st));}

Returns the modification time for the named file as aTime object.

file_name can be anIO object.

File.mtime("testfile")#=> Tue Apr 08 12:58:04 CDT 2003

static VALUErb_file_initialize(int argc, VALUE *argv, VALUE io){    if (RFILE(io)->fptr) {        rb_raise(rb_eRuntimeError, "reinitializing File");    }    VALUE fname, vmode, vperm, opt;    int posargc = rb_scan_args(argc, argv, "12:", &fname, &vmode, &vperm, &opt);    if (posargc < 3) {          /* perm is File only */        VALUE fd = rb_check_to_int(fname);        if (!NIL_P(fd)) {            return io_initialize(io, fd, vmode, opt);        }    }    return rb_open_file(io, fname, vmode, vperm, opt);}

Opens the file at the givenpath according to the givenmode; creates and returns a newFile object for that file.

The newFile object is buffered mode (or non-sync mode), unlessfilename is a tty. SeeIO#flush,IO#fsync,IO#fdatasync, andIO#sync=.

Argumentpath must be a valid file path:

f =File.new('/etc/fstab')f.closef =File.new('t.txt')f.close

Optional argumentmode (defaults to ‘r’) must specify a valid mode; seeAccess Modes:

f =File.new('t.tmp','w')f.closef =File.new('t.tmp',File::RDONLY)f.close

Optional argumentperm (defaults to 0666) must specify valid permissions seeFile Permissions:

f =File.new('t.tmp',File::CREAT,0644)f.closef =File.new('t.tmp',File::CREAT,0444)f.close

Optional keyword argumentsopts specify:

• Open Options.

• Encoding options.

static VALUErb_io_s_open(int argc, VALUE *argv, VALUE klass){    VALUE io = rb_class_new_instance_kw(argc, argv, klass, RB_PASS_CALLED_KEYWORDS);    if (rb_block_given_p()) {        return rb_ensure(rb_yield, io, io_close, io);    }    return io;}

Creates a newFile object, viaFile.new with the given arguments.

With no block given, returns theFile object.

With a block given, calls the block with theFile object and returns the block’s value.

static VALUErb_file_owned_p(VALUE obj, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    return RBOOL(st.st_uid == geteuid());}

Returnstrue if the named file exists and the effective used id of the calling process is the owner of the file.

file_name can be anIO object.

static VALUErb_file_s_path(VALUE klass, VALUE fname){    return rb_get_path(fname);}

ReturnsthestringrepresentationofthepathFile.path(File::NULL)#=> "/dev/null"File.path(Pathname.new("/tmp"))#=> "/tmp"

Ifpath is not a String:

1. If it has theto_path method, that method will be called to coerce to aString.

2. Otherwise, or if the coerced result is not aString too, the standard coersion usingto_str method will take place on that object. (See alsoString.try_convert)

The coerced string must satisfy the following conditions:

1. It must be in an ASCII-compatible encoding; otherwise, anEncoding::CompatibilityError is raised.

2. It must not contain the NUL character (\0); otherwise, anArgumentError is raised.

static VALUErb_file_pipe_p(VALUE obj, VALUE fname){#ifdef S_IFIFO#  ifndef S_ISFIFO#    define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)#  endif    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    if (S_ISFIFO(st.st_mode)) return Qtrue;#endif    return Qfalse;}

Returnstrue iffilepath points to a pipe,false otherwise:

File.mkfifo('tmp/fifo')File.pipe?('tmp/fifo')# => trueFile.pipe?('t.txt')# => false

static VALUErb_file_readable_p(VALUE obj, VALUE fname){    return RBOOL(rb_eaccess(fname, R_OK) >= 0);}

Returnstrue if the named file is readable by the effective user and group id of this process. See eaccess(3).

Note that some OS-level security features may cause this to return true even though the file is not readable by the effective user/group.

static VALUErb_file_readable_real_p(VALUE obj, VALUE fname){    return RBOOL(rb_access(fname, R_OK) >= 0);}

Returnstrue if the named file is readable by the real user and group id of this process. See access(3).

Note that some OS-level security features may cause this to return true even though the file is not readable by the real user/group.

static VALUErb_file_s_readlink(VALUE klass, VALUE path){    return rb_readlink(path, rb_filesystem_encoding());}

Returns the name of the file referenced by the given link. Not available on all platforms.

File.symlink("testfile","link2test")#=> 0File.readlink("link2test")#=> "testfile"

static VALUErb_file_s_realdirpath(int argc, VALUE *argv, VALUE klass){    VALUE basedir = (rb_check_arity(argc, 1, 2) > 1) ? argv[1] : Qnil;    VALUE path = argv[0];    FilePathValue(path);    return rb_realpath_internal(basedir, path, 0);}

Returns the real (absolute) pathname ofpathname in the actual filesystem. The real pathname doesn’t contain symlinks or useless dots.

Ifdir_string is given, it is used as a base directory for interpreting relative pathname instead of the current directory.

The last component of the real pathname can be nonexistent.

static VALUErb_file_s_realpath(int argc, VALUE *argv, VALUE klass){    VALUE basedir = (rb_check_arity(argc, 1, 2) > 1) ? argv[1] : Qnil;    VALUE path = argv[0];    FilePathValue(path);    return rb_realpath_internal(basedir, path, 1);}

Returns the real (absolute) pathname ofpathname in the actual filesystem not containing symlinks or useless dots.

Ifdir_string is given, it is used as a base directory for interpreting relative pathname instead of the current directory.

All components of the pathname must exist when this method is called.

static VALUErb_file_s_rename(VALUE klass, VALUE from, VALUE to){    struct rename_args ra;    VALUE f, t;    FilePathValue(from);    FilePathValue(to);    f = rb_str_encode_ospath(from);    t = rb_str_encode_ospath(to);    ra.src = StringValueCStr(f);    ra.dst = StringValueCStr(t);#if defined __CYGWIN__    errno = 0;#endif    if (IO_WITHOUT_GVL_INT(no_gvl_rename, &ra) < 0) {        int e = errno;#if defined DOSISH        switch (e) {          case EEXIST:            if (chmod(ra.dst, 0666) == 0 &&                unlink(ra.dst) == 0 &&                rename(ra.src, ra.dst) == 0)                return INT2FIX(0);        }#endif        syserr_fail2(e, from, to);    }    return INT2FIX(0);}

Renames the given file to the new name. Raises aSystemCallError if the file cannot be renamed.

File.rename("afile","afile.bak")#=> 0

static VALUErb_file_sgid_p(VALUE obj, VALUE fname){#ifdef S_ISGID    return check3rdbyte(fname, S_ISGID);#else    return Qfalse;#endif}

Returnstrue if the named file has the setgid bit set.

file_name can be anIO object.

static VALUErb_file_suid_p(VALUE obj, VALUE fname){#ifdef S_ISUID    return check3rdbyte(fname, S_ISUID);#else    return Qfalse;#endif}

Returnstrue if the named file has the setuid bit set.

file_name can be anIO object.

static VALUErb_file_s_size(VALUE klass, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) {        int e = errno;        FilePathValue(fname);        rb_syserr_fail_path(e, fname);    }    return OFFT2NUM(st.st_size);}

Returns the size offile_name.

file_name can be anIO object.

static VALUErb_file_size_p(VALUE obj, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) return Qnil;    if (st.st_size == 0) return Qnil;    return OFFT2NUM(st.st_size);}

Returnsnil iffile_name doesn’t exist or has zero size, the size of the file otherwise.

file_name can be anIO object.

static VALUErb_file_socket_p(VALUE obj, VALUE fname){#ifndef S_ISSOCK#  ifdef _S_ISSOCK#    define S_ISSOCK(m) _S_ISSOCK(m)#  else#    ifdef _S_IFSOCK#      define S_ISSOCK(m) (((m) & S_IFMT) == _S_IFSOCK)#    else#      ifdef S_IFSOCK#        define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)#      endif#    endif#  endif#endif#ifdef S_ISSOCK    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    if (S_ISSOCK(st.st_mode)) return Qtrue;#endif    return Qfalse;}

Returnstrue iffilepath points to a socket,false otherwise:

require'socket'File.socket?(Socket.new(:INET,:STREAM))# => trueFile.socket?(File.new('t.txt'))# => false

static VALUErb_file_s_split(VALUE klass, VALUE path){    FilePathStringValue(path);          /* get rid of converting twice */    return rb_assoc_new(rb_file_dirname(path), rb_file_s_basename(1,&path,Qundef));}

Splits the given string into a directory and a file component and returns them in a two-element array. See alsoFile::dirname andFile::basename.

File.split("/home/gumby/.profile")#=> ["/home/gumby", ".profile"]

static VALUErb_file_s_stat(VALUE klass, VALUE fname){    rb_io_stat_data st;    FilePathValue(fname);    fname = rb_str_encode_ospath(fname);    if (statx_without_gvl(RSTRING_PTR(fname), &st, STATX_ALL) < 0) {        rb_sys_fail_path(fname);    }    return rb_statx_new(&st);}

Returns aFile::Stat object for the file atfilepath (seeFile::Stat):

File.stat('t.txt').class# => File::Stat

static VALUErb_file_sticky_p(VALUE obj, VALUE fname){#ifdef S_ISVTX    return check3rdbyte(fname, S_ISVTX);#else    return Qfalse;#endif}

Returnstrue if the named file has the sticky bit set.

file_name can be anIO object.

static VALUErb_file_s_symlink(VALUE klass, VALUE from, VALUE to){    FilePathValue(from);    FilePathValue(to);    from = rb_str_encode_ospath(from);    to = rb_str_encode_ospath(to);    if (symlink(StringValueCStr(from), StringValueCStr(to)) < 0) {        sys_fail2(from, to);    }    return INT2FIX(0);}

Creates a symbolic link callednew_name for the existing fileold_name. Raises a NotImplemented exception on platforms that do not support symbolic links.

File.symlink("testfile","link2test")#=> 0

static VALUErb_file_symlink_p(VALUE obj, VALUE fname){#ifndef S_ISLNK#  ifdef _S_ISLNK#    define S_ISLNK(m) _S_ISLNK(m)#  else#    ifdef _S_IFLNK#      define S_ISLNK(m) (((m) & S_IFMT) == _S_IFLNK)#    else#      ifdef S_IFLNK#        define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)#      endif#    endif#  endif#endif#ifdef S_ISLNK    struct stat st;    FilePathValue(fname);    fname = rb_str_encode_ospath(fname);    if (lstat_without_gvl(StringValueCStr(fname), &st) < 0) return Qfalse;    if (S_ISLNK(st.st_mode)) return Qtrue;#endif    return Qfalse;}

Returnstrue iffilepath points to a symbolic link,false otherwise:

symlink =File.symlink('t.txt','symlink')File.symlink?('symlink')# => trueFile.symlink?('t.txt')# => false

static VALUErb_file_s_truncate(VALUE klass, VALUE path, VALUE len){    struct truncate_arg ta;    int r;    ta.pos = NUM2OFFT(len);    FilePathValue(path);    path = rb_str_encode_ospath(path);    ta.path = StringValueCStr(path);    r = IO_WITHOUT_GVL_INT(nogvl_truncate, &ta);    if (r < 0)        rb_sys_fail_path(path);    return INT2FIX(0);}

Truncates the filefile_name to be at mostinteger bytes long. Not available on all platforms.

f =File.new("out","w")f.write("1234567890")#=> 10f.close#=> nilFile.truncate("out",5)#=> 0File.size("out")#=> 5

static VALUErb_file_s_umask(int argc, VALUE *argv, VALUE _){    mode_t omask = 0;    switch (argc) {      case 0:        omask = umask(0);        umask(omask);        break;      case 1:        omask = umask(NUM2MODET(argv[0]));        break;      default:        rb_error_arity(argc, 0, 1);    }    return MODET2NUM(omask);}

Returns the current umask value for this process. If the optional argument is given, set the umask to that value and return the previous value. Umask values aresubtracted from the default permissions, so a umask of0222 would make a file read-only for everyone.

File.umask(0006)#=> 18File.umask#=> 6

static VALUErb_file_s_unlink(int argc, VALUE *argv, VALUE klass){    return apply2files(unlink_internal, argc, argv, 0);}

Deletes the named files, returning the number of names passed as arguments. Raises an exception on any error. Since the underlying implementation relies on theunlink(2) system call, the type of exception raised depends on its error type (seelinux.die.net/man/2/unlink) and has the form of e.g. Errno::ENOENT.

See alsoDir::rmdir.

static VALUErb_file_s_utime(int argc, VALUE *argv, VALUE _){    return utime_internal_i(argc, argv, FALSE);}

Sets the access and modification times of each named file to the first two arguments. If a file is a symlink, this method acts upon its referent rather than the link itself; for the inverse behavior seeFile.lutime. Returns the number of file names in the argument list.

static VALUErb_file_world_readable_p(VALUE obj, VALUE fname){#ifdef S_IROTH    struct stat st;    if (rb_stat(fname, &st) < 0) return Qnil;    if ((st.st_mode & (S_IROTH)) == S_IROTH) {        return UINT2NUM(st.st_mode & (S_IRUGO|S_IWUGO|S_IXUGO));    }#endif    return Qnil;}

Iffile_name is readable by others, returns an integer representing the file permission bits offile_name. Returnsnil otherwise. The meaning of the bits is platform dependent; on Unix systems, seestat(2).

file_name can be anIO object.

File.world_readable?("/etc/passwd")#=> 420m =File.world_readable?("/etc/passwd")sprintf("%o",m)#=> "644"

static VALUErb_file_world_writable_p(VALUE obj, VALUE fname){#ifdef S_IWOTH    struct stat st;    if (rb_stat(fname, &st) < 0) return Qnil;    if ((st.st_mode & (S_IWOTH)) == S_IWOTH) {        return UINT2NUM(st.st_mode & (S_IRUGO|S_IWUGO|S_IXUGO));    }#endif    return Qnil;}

Iffile_name is writable by others, returns an integer representing the file permission bits offile_name. Returnsnil otherwise. The meaning of the bits is platform dependent; on Unix systems, seestat(2).

file_name can be anIO object.

File.world_writable?("/tmp")#=> 511m =File.world_writable?("/tmp")sprintf("%o",m)#=> "777"

static VALUErb_file_writable_p(VALUE obj, VALUE fname){    return RBOOL(rb_eaccess(fname, W_OK) >= 0);}

Returnstrue if the named file is writable by the effective user and group id of this process. See eaccess(3).

Note that some OS-level security features may cause this to return true even though the file is not writable by the effective user/group.

static VALUErb_file_writable_real_p(VALUE obj, VALUE fname){    return RBOOL(rb_access(fname, W_OK) >= 0);}

Returnstrue if the named file is writable by the real user and group id of this process. See access(3).

Note that some OS-level security features may cause this to return true even though the file is not writable by the real user/group.

static VALUErb_file_zero_p(VALUE obj, VALUE fname){    struct stat st;    if (rb_stat(fname, &st) < 0) return Qfalse;    return RBOOL(st.st_size == 0);}

Returnstrue if the named file exists and has a zero size.

file_name can be anIO object.

static VALUErb_file_atime(VALUE obj){    rb_io_t *fptr;    struct stat st;    GetOpenFile(obj, fptr);    if (fstat(fptr->fd, &st) == -1) {        rb_sys_fail_path(fptr->pathv);    }    return stat_time(stat_atimespec(&st));}

Returns the last access time (aTime object) forfile, or epoch iffile has not been accessed.

File.new("testfile").atime#=> Wed Dec 31 18:00:00 CST 1969

static VALUErb_file_birthtime(VALUE obj){    rb_io_t *fptr;    rb_io_stat_data st;    GetOpenFile(obj, fptr);    if (fstatx_without_gvl(fptr, &st, STATX_BTIME) == -1) {        rb_sys_fail_path(fptr->pathv);    }    return statx_birthtime(&st);}

Returns the birth time forfile.

File.new("testfile").birthtime#=> Wed Apr 09 08:53:14 CDT 2003

If the platform doesn’t have birthtime, raisesNotImplementedError.

static VALUErb_file_chmod(VALUE obj, VALUE vmode){    rb_io_t *fptr;    mode_t mode;#if !defined HAVE_FCHMOD || !HAVE_FCHMOD    VALUE path;#endif    mode = NUM2MODET(vmode);    GetOpenFile(obj, fptr);#ifdef HAVE_FCHMOD    if (rb_fchmod(fptr, mode) == -1) {        if (HAVE_FCHMOD || errno != ENOSYS)            rb_sys_fail_path(fptr->pathv);    }    else {        if (!HAVE_FCHMOD) return INT2FIX(0);    }#endif#if !defined HAVE_FCHMOD || !HAVE_FCHMOD    if (NIL_P(fptr->pathv)) return Qnil;    path = rb_str_encode_ospath(fptr->pathv);    if (rb_chmod(RSTRING_PTR(path), mode) == -1)        rb_sys_fail_path(fptr->pathv);#endif    return INT2FIX(0);}

Changes permission bits onfile to the bit pattern represented bymode_int. Actual effects are platform dependent; on Unix systems, seechmod(2) for details. Follows symbolic links. Also see File#lchmod.

f =File.new("out","w");f.chmod(0644)#=> 0

static VALUErb_file_chown(VALUE obj, VALUE owner, VALUE group){    rb_io_t *fptr;    rb_uid_t o;    rb_gid_t g;#ifndef HAVE_FCHOWN    VALUE path;#endif    o = to_uid(owner);    g = to_gid(group);    GetOpenFile(obj, fptr);#ifndef HAVE_FCHOWN    if (NIL_P(fptr->pathv)) return Qnil;    path = rb_str_encode_ospath(fptr->pathv);    if (rb_chown(RSTRING_PTR(path), o, g) == -1)        rb_sys_fail_path(fptr->pathv);#else    if (rb_fchown(fptr->fd, o, g) == -1)        rb_sys_fail_path(fptr->pathv);#endif    return INT2FIX(0);}

Changes the owner and group offile to the given numeric owner and group id’s. Only a process with superuser privileges may change the owner of a file. The current owner of a file may change the file’s group to any group to which the owner belongs. Anil or -1 owner or group id is ignored. Follows symbolic links. See also File#lchown.

File.new("testfile").chown(502,1000)

static VALUErb_file_ctime(VALUE obj){    rb_io_t *fptr;    struct stat st;    GetOpenFile(obj, fptr);    if (fstat(fptr->fd, &st) == -1) {        rb_sys_fail_path(fptr->pathv);    }    return stat_time(stat_ctimespec(&st));}

Returns the change time forfile (that is, the time directory information about the file was changed, not the file itself).

Note that on Windows (NTFS), returns creation time (birth time).

File.new("testfile").ctime#=> Wed Apr 09 08:53:14 CDT 2003

static VALUErb_file_flock(VALUE obj, VALUE operation){    rb_io_t *fptr;    int op[2], op1;    struct timeval time;    op[1] = op1 = NUM2INT(operation);    GetOpenFile(obj, fptr);    op[0] = fptr->fd;    if (fptr->mode & FMODE_WRITABLE) {        rb_io_flush_raw(obj, 0);    }    while ((int)rb_io_blocking_region(fptr, rb_thread_flock, op) < 0) {        int e = errno;        switch (e) {          case EAGAIN:          case EACCES:#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN          case EWOULDBLOCK:#endif            if (op1 & LOCK_NB) return Qfalse;            time.tv_sec = 0;            time.tv_usec = 100 * 1000;  /* 0.1 sec */            rb_thread_wait_for(time);            rb_io_check_closed(fptr);            continue;          case EINTR:#if defined(ERESTART)          case ERESTART:#endif            break;          default:            rb_syserr_fail_path(e, fptr->pathv);        }    }    return INT2FIX(0);}

Locks or unlocks fileself according to the givenlocking_constant, a bitwise OR of the values in the table below.

Not available on all platforms.

Returnsfalse ifFile::LOCK_NB is specified and the operation would have blocked; otherwise returns0.

Example:

# Update a counter using an exclusive lock.# Don't use File::WRONLY because it truncates the file.File.open('counter',File::RDWR|File::CREAT,0644)do|f|f.flock(File::LOCK_EX)value =f.read.to_i+1f.rewindf.write("#{value}\n")f.flushf.truncate(f.pos)end# Read the counter using a shared lock.File.open('counter','r')do|f|f.flock(File::LOCK_SH)f.readend

static VALUErb_file_lstat(VALUE obj){#ifdef HAVE_LSTAT    rb_io_t *fptr;    rb_io_stat_data st;    VALUE path;    GetOpenFile(obj, fptr);    if (NIL_P(fptr->pathv)) return Qnil;    path = rb_str_encode_ospath(fptr->pathv);    if (lstatx_without_gvl(RSTRING_PTR(path), &st, STATX_ALL) == -1) {        rb_sys_fail_path(fptr->pathv);    }    return rb_statx_new(&st);#else    return rb_io_stat(obj);#endif}

LikeFile#stat, but does not follow the last symbolic link; instead, returns aFile::Stat object for the link itself:

File.symlink('t.txt','symlink')f =File.new('symlink')f.stat.size# => 47f.lstat.size# => 11

static VALUErb_file_mtime(VALUE obj){    rb_io_t *fptr;    struct stat st;    GetOpenFile(obj, fptr);    if (fstat(fptr->fd, &st) == -1) {        rb_sys_fail_path(fptr->pathv);    }    return stat_time(stat_mtimespec(&st));}

Returns the modification time forfile.

File.new("testfile").mtime#=> Wed Apr 09 08:53:14 CDT 2003

static VALUEfile_size(VALUE self){    return OFFT2NUM(rb_file_size(self));}

Returns the size offile in bytes.

File.new("testfile").size#=> 66

static VALUErb_file_truncate(VALUE obj, VALUE len){    rb_io_t *fptr;    struct ftruncate_arg fa;    fa.pos = NUM2OFFT(len);    GetOpenFile(obj, fptr);    if (!(fptr->mode & FMODE_WRITABLE)) {        rb_raise(rb_eIOError, "not opened for writing");    }    rb_io_flush_raw(obj, 0);    fa.fd = fptr->fd;    if ((int)rb_io_blocking_region(fptr, nogvl_ftruncate, &fa) < 0) {        rb_sys_fail_path(fptr->pathv);    }    return INT2FIX(0);}

Truncatesfile to at mostinteger bytes. The file must be opened for writing. Not available on all platforms.

f =File.new("out","w")f.syswrite("1234567890")#=> 10f.truncate(5)#=> 0f.close()#=> nilFile.size("out")#=> 5