aboutsummaryrefslogtreecommitdiff
path: root/field_string.go
blob: 60b5ab3f49dca3972c591f64f1d7071b8e9fbc74 (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
// SPDX-FileCopyrightText: 2018 Stefan Majewsky <majewsky@gmx.net>
// SPDX-License-Identifier: Apache-2.0

package schwift

// FieldString is a helper type that provides type-safe access to a Swift header key
// whose value is a string. It cannot be directly constructed, but methods on
// the Headers types return this type. For example:
//
//	hdr := NewAccountHeaders()
//	//the following two statements are equivalent:
//	hdr["X-Container-Read"] = ".r:*,.rlistings"
//	hdr.ReadACL().Set(".r:*,.rlistings")
type FieldString struct {
	h Headers
	k string
}

// Exists checks whether there is a value for this header.
func (f FieldString) Exists() bool {
	return f.h.Get(f.k) != ""
}

// Get returns the value for this header, or the empty string if there is no value.
func (f FieldString) Get() string {
	return f.h.Get(f.k)
}

// Set writes a new value for this header into the corresponding headers
// instance.
func (f FieldString) Set(value string) {
	f.h.Set(f.k, value)
}

// Del removes this key from the original headers instance, so that the
// key will remain unchanged on the server during Update().
func (f FieldString) Del() {
	f.h.Del(f.k)
}

// Clear sets this key to an empty string in the original headers
// instance, so that the key will be removed on the server during Update().
func (f FieldString) Clear() {
	f.h.Clear(f.k)
}

func (f FieldString) validate() error {
	return nil
}