Detect End-of-File on a Remote SFTP File

See more SFTP Examples

Demonstrates the Chilkat SFtp.Eof method, which returns whether the most recent read for a handle received the SFTP end-of-file status. The only argument is the handle. This example reads until Eof is true.

Background: The timing here is worth understanding: reading exactly through the final byte does not immediately set EOF. The next read succeeds, returns zero bytes, sets the status to SSH_FX_EOF, and only then does Eof report true. That is why the loop tests Eof after each read rather than assuming a short read means the end — a short read can also just be the server returning less than requested.

Chilkat Go Downloads

Download Chilkat for Go

    success := false

    //  Demonstrates the SFtp.Eof method, which returns whether the most recent read for a handle
    //  received the SFTP end-of-file status.  The only argument is the handle.

    sftp := chilkat.NewSFtp()

    //  Connect, authenticate, and initialize the SFTP subsystem.
    port := 22
    success = sftp.Connect("sftp.example.com",port)
    if success == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    //  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.
    password := "mySshPassword"

    success = sftp.AuthenticatePw("mySshLogin",password)
    if success == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    success = sftp.InitializeSftp()
    if success == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    handle := sftp.OpenFile("subdir/data.txt","readOnly","openExisting")
    if sftp.LastMethodSuccess() == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    //  Read until Eof reports the end of the file.  Note that reading exactly through the final byte
    //  does not set EOF; the next read returns zero bytes and then Eof becomes true.
    sbContent := chilkat.NewStringBuilder()
    chunkSize := 4096
    reading := true
    for reading {
        chunk := sftp.ReadFileText(*handle,chunkSize,"utf-8")
        if sftp.LastReadFailed(*handle) {
            fmt.Println(sftp.LastErrorText())
            sftp.DisposeSFtp()
            sbContent.DisposeStringBuilder()
            return
        }

        sbContent.Append(*chunk)
        reading = !sftp.Eof(*handle)
    }

    success = sftp.CloseHandle(*handle)
    if success == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        sbContent.DisposeStringBuilder()
        return
    }

    fmt.Println(*sbContent.GetAsString())

    sftp.Disconnect()

    sftp.DisposeSFtp()
    sbContent.DisposeStringBuilder()