1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/******************************************************************************
*
* Copyright 2018 Stefan Majewsky <majewsky@gmx.net>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************/
package schwift
import (
"io"
)
// DownloadedObject is returned by Object.Download(). It wraps the io.ReadCloser
// from http.Response.Body with convenience methods for collecting the contents
// into a byte slice or string.
//
// var obj *swift.Object
//
// //Do NOT do this!
// reader, err := obj.Download(nil).AsReadCloser()
// bytes, err := io.ReadAll(reader)
// err := reader.Close()
// str := string(bytes)
//
// //Do this instead:
// str, err := obj.Download(nil).AsString()
//
// Since all methods on DownloadedObject are irreversible, the idiomatic way of
// using DownloadedObject is to call one of its members immediately, without
// storing the DownloadedObject instance in a variable first.
//
// var obj *swift.Object
//
// //Do NOT do this!
// downloaded := obj.Download(nil)
// reader, err := downloaded.AsReadCloser()
//
// //Do this instead:
// reader, err := obj.Download(nil).AsReadCloser()
type DownloadedObject struct {
r io.ReadCloser
err error
}
// AsReadCloser returns an io.ReadCloser containing the contents of the
// downloaded object.
func (o DownloadedObject) AsReadCloser() (io.ReadCloser, error) {
return o.r, o.err
}
// AsByteSlice collects the contents of this downloaded object into a byte slice.
func (o DownloadedObject) AsByteSlice() ([]byte, error) {
if o.err != nil {
return nil, o.err
}
slice, err := io.ReadAll(o.r)
closeErr := o.r.Close()
if err == nil {
err = closeErr
}
return slice, err
}
// AsString collects the contents of this downloaded object into a string.
func (o DownloadedObject) AsString() (string, error) {
slice, err := o.AsByteSlice()
return string(slice), err
}
|
