aboutsummaryrefslogtreecommitdiff
path: root/download.go
blob: 1297850c01a1839d72c4473fbd50b247d04f3335 (plain)
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
// SPDX-FileCopyrightText: 2018 Stefan Majewsky <majewsky@gmx.net>
// SPDX-License-Identifier: Apache-2.0

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
}