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

     1  syntax = "proto3";
     2  
     3  package rsync;
     4  
     5  option go_package = "github.com/mutagen-io/mutagen/pkg/synchronization/rsync";
     6  
     7  import "synchronization/rsync/engine.proto";
     8  
     9  // Transmission represents a single message in a transmission stream. As a
    10  // Protocol Buffers message type, its internals are inherently public, but it
    11  // should otherwise be treated as an opaque type with a private implementation.
    12  message Transmission {
    13      // ExpectedSize sets the expected size for the current incoming file. It is
    14      // only set alongside the first operation in a file's transmission stream.
    15      // If it zero, then the file's size should be treated as unknown, because a
    16      // file of zero size will receive an immediate "done" transmission and would
    17      // not be indicated as having zero size.
    18      uint64 expectedSize = 1;
    19      // Operation is the next operation in the transmission stream for the
    20      // current file.
    21      Operation operation = 2;
    22      // Done indicates that the transmission stream for the current file is
    23      // finished. If Done is true, then there will be no operation set, but there
    24      // may be an error set.
    25      bool done = 3;
    26      // Error indicates that a non-terminal error has occurred. It can only be
    27      // present if Done is true.
    28      string error = 4;
    29  }