github.com/mutagen-io/mutagen@v0.18.0-rc1/pkg/synchronization/rsync/receive.proto (about)

     1  syntax = "proto3";
     2  
     3  package rsync;
     4  
     5  option go_package = "github.com/mutagen-io/mutagen/pkg/synchronization/rsync";
     6  
     7  // ReceiverState encodes that status of an rsync receiver. It should be
     8  // considered immutable.
     9  message ReceiverState {
    10      // Path is the path currently being received.
    11      string path = 1;
    12      // ReceivedSize is the number of bytes that have been received for the
    13      // current path from both block and data operations.
    14      uint64 receivedSize = 2;
    15      // ExpectedSize is the number of bytes expected for the current path.
    16      uint64 expectedSize = 3;
    17      // ReceivedFiles is the number of files that have already been received.
    18      uint64 receivedFiles = 4;
    19      // ExpectedFiles is the total number of files expected.
    20      uint64 expectedFiles = 5;
    21      // TotalReceivedSize is the total number of bytes that have been received
    22      // for all files from both block and data operations.
    23      uint64 totalReceivedSize = 6;
    24      // TODO: We may want to add statistics on the speedup offered by the rsync
    25      // algorithm in terms of data volume, though obviously this can't account
    26      // for any savings that might come from compression at the transport layer.
    27      // It would also be really nice to have TotalExpectedSize, but this is
    28      // prohibitively difficult and expensive to compute.
    29  }