aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Majewsky <stefan.majewsky@sap.com>2021-05-28 13:59:38 +0200
committerStefan Majewsky <stefan.majewsky@sap.com>2021-05-28 13:59:38 +0200
commitf5332c147be25b138294151b3dd57ec4e0f28e26 (patch)
tree0470e64cd9e59ee6f8d6a8f4fe65a1878ada62a1
parent4caefbba49a5675d39fa87f26a757f8131313598 (diff)
downloadgo-schwift-f5332c147be25b138294151b3dd57ec4e0f28e26.tar.gz
rename Object.UploadWithWriter to UploadFromWriter
-rw-r--r--object.go10
-rw-r--r--tests/object_test.go2
2 files changed, 5 insertions, 7 deletions
diff --git a/object.go b/object.go
index 9969ea9..266415f 100644
--- a/object.go
+++ b/object.go
@@ -180,7 +180,7 @@ type UploadOptions struct {
//
//If you have neither an io.Reader nor a []byte or string, but you have a
//function that generates the object's content into an io.Writer, use
-//UploadWithWriter instead.
+//UploadFromWriter instead.
//
//If the object is very large and you want to upload it in segments, use
//LargeObject.Append() instead. See documentation on type LargeObject for
@@ -325,7 +325,7 @@ func tryComputeEtag(content io.Reader, headers ObjectHeaders) {
}
}
-//UploadWithWriter is a variant of Upload that can be used when the object's
+//UploadFromWriter is a variant of Upload that can be used when the object's
//content is generated by some function or package that takes an io.Writer
//instead of supplying an io.Reader. For example:
//
@@ -335,7 +335,7 @@ func tryComputeEtag(content io.Reader, headers ObjectHeaders) {
// }
//
// obj := container.Object("greeting-for-susan-and-jeffrey")
-// err := obj.UploadWithWriter(nil, func(w io.Writer) error {
+// err := obj.UploadFromWriter(nil, func(w io.Writer) error {
// err := greeting(w, "Susan")
// if err == nil {
// err = greeting(w, "Jeffrey")
@@ -344,9 +344,7 @@ func tryComputeEtag(content io.Reader, headers ObjectHeaders) {
// })
//
//If you do not need an io.Writer, always use Upload instead.
-//
-//TODO rename to UploadViaWriter
-func (o *Object) UploadWithWriter(opts *UploadOptions, ropts *RequestOptions, callback func(io.Writer) error) error {
+func (o *Object) UploadFromWriter(opts *UploadOptions, ropts *RequestOptions, callback func(io.Writer) error) error {
reader, writer := io.Pipe()
errChan := make(chan error)
go func() {
diff --git a/tests/object_test.go b/tests/object_test.go
index 15aa8f2..1575a31 100644
--- a/tests/object_test.go
+++ b/tests/object_test.go
@@ -90,7 +90,7 @@ func TestObjectUpload(t *testing.T) {
//test upload with io.Writer
obj = c.Object("upload5")
- err = obj.UploadWithWriter(nil, nil, func(w io.Writer) error {
+ err = obj.UploadFromWriter(nil, nil, func(w io.Writer) error {
_, err := w.Write(objectExampleContent)
return err
})