Ruby

Get an FTP Listing Entry's Size (32-bit)

Demonstrates the Chilkat Ftp2.GetSize method, which returns the size in bytes of a cached directory-listing entry as a 32-bit integer. The only argument is a zero-based index. It returns -1 when the index is invalid or the size is unavailable.

Background: The size comes from the cached listing, so reading it for every entry costs no extra round trips. A 32-bit result cannot represent files past about 2 GB, so use GetSize64 (or GetSizeStr) when large files are possible. Directories often report no meaningful size and come back as -1, which is why the -1 case is worth handling rather than printing blindly.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Ftp2.GetSize method, which returns the size in bytes of a cached
#  directory-listing entry as a 32-bit integer.  The only argument is a zero-based index.

ftp = Chilkat::CkFtp2.new()

ftp.put_Hostname("ftp.example.com")
ftp.put_Username("myFtpLogin")

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
ftp.put_Password("myPassword")

success = ftp.Connect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

success = ftp.ChangeRemoteDir("public_html")
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

#  GetDirCount retrieves the directory listing on the first call and returns the number of
#  entries.  A negative return indicates failure.
n = ftp.GetDirCount()
if (n < 0)
    print ftp.lastErrorText() + "\n";
    exit
end

for i in 0 .. n - 1
    name = ftp.getFilename(i)

    #  GetSize returns -1 when the index is invalid or the size is unavailable (for example for a
    #  directory).  Use GetSize64 for files that may exceed 2 GB.
    fileSize = ftp.GetSize(i)
    print name + "  " + fileSize.to_s() + " bytes" + "\n";
end

success = ftp.Disconnect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end