Skip to content

Commit

Permalink
update docs with suggested improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
emar-kar committed Jun 5, 2024
1 parent 1629551 commit 1988803
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions client.go
Original file line number Diff line number Diff line change
Expand Up @@ -1757,7 +1757,8 @@ func (f *File) writeAt(b []byte, off int64) (written int, err error) {
//
// Otherwise, the given concurrency will be capped by the Client's max concurrency.
//
// This method is preferred over calling ReadFrom to guarantee concurrent reads/writes.
// When one needs to guarantee concurrent reads/writes, this method is preferred
// over ReadFrom.
func (f *File) ReadFromWithConcurrency(r io.Reader, concurrency int) (read int64, err error) {
f.mu.Lock()
defer f.mu.Unlock()
Expand Down Expand Up @@ -1919,16 +1920,17 @@ func (f *File) readFromWithConcurrency(r io.Reader, concurrency int) (read int64
// to maximise throughput for transferring the entire file,
// especially over high-latency links.
//
// If client uses concurrent writes, given r needs to implement one of the interfaces:
// To ensure concurrent writes, the given r needs to implement one of
// the following receiver methods:
//
// Len() int
// Size() int64
// Stat() (os.FileInfo, error)
//
// or be an instance of [io.LimitedReader] to determine the number of possible
// concurrent requests. Otherwise, reads/writes are performed in nonparallel, sliced
// in chunks with the max packet size. ReadFromWithConcurrency explicit call can
// guarantee concurrent processing of the reader.
// concurrent requests. Otherwise, reads/writes are performed sequentially.
// ReadFromWithConcurrency can be used explicitly to guarantee concurrent
// processing of the reader.
func (f *File) ReadFrom(r io.Reader) (int64, error) {
f.mu.Lock()
defer f.mu.Unlock()
Expand Down

0 comments on commit 1988803

Please sign in to comment.