-
Notifications
You must be signed in to change notification settings - Fork 0
/
optional.go
561 lines (501 loc) · 13.4 KB
/
optional.go
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
package gopt
import (
"database/sql"
"encoding/json"
"errors"
"reflect"
)
type String *string
// NotPresent is the error returned from Optional.Get when the value is not present
var NotPresent = errors.New("not present")
// Of creates a new optional with the supplied value
func Of[T any](value T) *Optional[T] {
return &Optional[T]{
present: isPresent(value),
value: value,
}
}
// OfNillable creates a new optional with the supplied value
//
// If the supplied value is nil, an empty (not present) optional is returned
func OfNillable[T any](value T) *Optional[T] {
if isPresent(value) {
return &Optional[T]{
present: true,
value: value,
}
}
return &Optional[T]{
present: false,
}
}
// OfNillableString creates a new string optional with the supplied value
//
// If the supplied value is an empty string, an empty (not-present) optional is returned
func OfNillableString(value string) *Optional[string] {
return &Optional[string]{
present: value != "",
value: value,
}
}
// Empty creates a new empty (not-present) optional of the specified type
func Empty[T any]() *Optional[T] {
return &Optional[T]{
present: false,
}
}
// MapTo maps the supplied optional to the specified type (if present and can can be converted) and returns an optional of the mapped value
func MapTo[T any](o *Optional[any]) *Optional[T] {
if o != nil && o.present {
if v, ok := o.value.(T); ok {
return Of[T](v)
}
}
return Empty[T]()
}
// ConvertTo converts the supplied optional to the specified type (if present and can can be converted) and returns an optional of converted value
//
// If the present value cannot be converted, the supplied conversion function is called
func ConvertTo[F any, T any](o *Optional[F], f func(v F) *Optional[T]) *Optional[T] {
if o != nil && o.present {
if v, ok := any(o.value).(T); ok {
return Of[T](v)
} else if f != nil {
return f(o.value)
}
}
return Empty[T]()
}
func isPresent(v any) bool {
vo := reflect.ValueOf(v)
switch vk := vo.Kind(); vk {
case reflect.Ptr:
vk = vo.Elem().Kind()
if vk == reflect.Invalid {
return false
}
case reflect.Map, reflect.Slice, reflect.Interface:
return !vo.IsNil()
}
return v != nil
}
type Optional[T any] struct {
present bool
value T
set bool
}
// AsEmpty returns a new empty optional of the same type
func (o *Optional[T]) AsEmpty() *Optional[T] {
return &Optional[T]{
present: false,
}
}
// Clear clears the optional
//
// Clearing sets the present to false, the set flag to false and the value to an empty value
func (o *Optional[T]) Clear() *Optional[T] {
o.clear(false)
return o
}
// Filter if the value is present and calling the supplied filter function returns true, returns a new optional describing the value
//
// Otherwise returns an empty optional
func (o *Optional[T]) Filter(f func(v T) bool) *Optional[T] {
if o.present && f != nil && f(o.value) {
return &Optional[T]{
present: true,
value: o.value,
}
}
return &Optional[T]{
present: false,
}
}
// Get returns the value and an error if the value is not present
func (o *Optional[T]) Get() (T, error) {
if !o.present {
return o.emptyValue(), NotPresent
}
return o.value, nil
}
// Default returns the value if present, otherwise returns the provided default value
func (o *Optional[T]) Default(v T) T {
if !o.present {
return v
}
return o.value
}
// GetOk returns the value and true if the value is present
//
// otherwise returns an empty value and false
//
// GetOk is similar to Get, except that rather than returning an error if not present it
// returns a boolean
func (o *Optional[T]) GetOk() (T, bool) {
if o.present {
return o.value, true
}
return o.emptyValue(), false
}
// IfElse if the supplied condition is true and the value is present, returns the value
//
// otherwise the other value is returned
func (o *Optional[T]) IfElse(condition bool, other T) T {
if condition && o.present {
return o.value
}
return other
}
// IfPresent if the value is present, calls the supplied function with the value, otherwise does nothing
func (o *Optional[T]) IfPresent(f func(v T)) *Optional[T] {
if o.present && f != nil {
f(o.value)
}
return o
}
// IfPresentOtherwise if the value is present, calls the supplied function with the value, otherwise calls the other function
func (o *Optional[T]) IfPresentOtherwise(f func(v T), other func()) *Optional[T] {
if o.present && f != nil {
f(o.value)
} else if !o.present && other != nil {
other()
}
return o
}
// IfSet if the value was set and is present, calls the supplied function with the value
//
// if the value was set but is not present, calls the supplied notPresent function
//
// otherwise, does nothing
func (o *Optional[T]) IfSet(f func(v T), notPresent func()) *Optional[T] {
if o.set && o.present && f != nil {
f(o.value)
} else if o.set && !o.present && notPresent != nil {
notPresent()
}
return o
}
// IfSetOtherwise if the value was set and is present, calls the supplied function with the value
//
// if the value was set but is not present, calls the supplied notPresent function
//
// otherwise, calls the other func
func (o *Optional[T]) IfSetOtherwise(f func(v T), notPresent func(), other func()) *Optional[T] {
if o.set && o.present && f != nil {
f(o.value)
} else if o.set && !o.present && notPresent != nil {
notPresent()
} else if !o.set && !o.present && other != nil {
other()
}
return o
}
// IsPresent returns true if the value is present, otherwise false
func (o *Optional[T]) IsPresent() bool {
return o.present
}
// Get if the value is present and the result of calling the supplied mapping function returns non-nil, returns
// an optional describing that returned value
//
// Otherwise returns an empty optional
func (o *Optional[T]) Map(f func(v T) any) *Optional[any] {
if o.present && f != nil {
v := f(o.value)
if isPresent(v) {
return Of(v)
}
}
return &Optional[any]{
present: false,
}
}
// MarshalJSON implements JSON marshal
//
// If the value is present, returns the marshalled data for the value
//
// Otherwise, returns the marshalled data for null
func (o *Optional[T]) MarshalJSON() ([]byte, error) {
if !o.present {
return []byte("null"), nil
}
return json.Marshal(o.value)
}
// OrElse returns the value if present, otherwise returns other
func (o *Optional[T]) OrElse(other T) T {
if o.present {
return o.value
}
return other
}
// OrElseError returns the supplied error if the value is not present, otherwise returns nil
//
// if the supplied error is nil and the value is not present, a NotPresent error is returned
func (o *Optional[T]) OrElseError(err error) error {
if !o.present {
if err == nil {
return NotPresent
}
return err
}
return nil
}
// OrElseGet returns the value if present, otherwise returns the result of calling the supplied function
//
// if the supplied function is nil and the value is not present, returns a default empty value
func (o *Optional[T]) OrElseGet(f func() T) T {
if o.present {
return o.value
} else if f != nil {
return f()
}
return o.emptyValue()
}
// OrElsePanic if the value is not present, panics with the supplied value, otherwise does nothing
func (o *Optional[T]) OrElsePanic(v any) *Optional[T] {
if !o.present {
panic(v)
}
return o
}
// OrElseSet if the value is not present it is set to the supplied value
func (o *Optional[T]) OrElseSet(v T) *Optional[T] {
if !o.present {
if isPresent(v) {
o.present = true
o.value = v
} else {
o.present = false
o.value = o.emptyValue()
}
o.set = true
}
return o
}
// Scan implements sql.Scan
func (o *Optional[T]) Scan(value interface{}) error {
if value == nil {
o.clear(true)
} else if av, ok := value.(T); ok {
o.present = true
o.value = av
o.set = true
} else if ok, err := o.callScannable(value); ok {
return err
} else if bd, ok := value.([]byte); ok {
var uv T
if o.isString() {
o.present = true
o.set = true
o.value = any(string(bd)).(T)
} else {
if unErr := json.Unmarshal(bd, &uv); unErr == nil {
if isPresent(uv) {
o.present = true
o.value = uv
} else {
o.present = false
o.value = o.emptyValue()
}
o.set = true
} else {
o.clear(true)
return unErr
}
}
} else {
o.clear(true)
}
return nil
}
// UnSet clears the set flag (see WasSet)
func (o *Optional[T]) UnSet() *Optional[T] {
o.set = false
return o
}
// UnmarshalJSON implements JSON unmarshal
//
// if the supplied data is null representation, sets the present to false
//
// Otherwise, unmarshal the data as the value and sets the optional to present (unless the result of
// unmarshalling the value returns an error - in which case the present is set to false)
func (o *Optional[T]) UnmarshalJSON(data []byte) error {
if len(data) == 4 && data[0] == 'n' && data[1] == 'u' && data[2] == 'l' && data[3] == 'l' {
o.present = false
o.value = o.emptyValue()
o.set = true
return nil
}
v := o.value
err := json.Unmarshal(data, &v)
if err == nil && isPresent(v) {
o.present = true
o.value = v
} else {
o.present = false
o.value = o.emptyValue()
}
o.set = true
return err
}
// WasSet returns true if the last setting operation set the value, otherwise false
//
// Setting operations are UnmarshalJSON, Scan and OrElseSet
//
// Use UnSet() to clear this flag alone
func (o *Optional[T]) WasSet() bool {
return o.set
}
// WasSetElse returns the value if present and set, otherwise returns other
func (o *Optional[T]) WasSetElse(other T) T {
if o.present && o.set {
return o.value
}
return other
}
// WasSetElseError returns the supplied error if the value is not present and set, otherwise returns nil
//
// if the supplied error is nil and the value is not present and set, a NotPresentError is returned
func (o *Optional[T]) WasSetElseError(err error) error {
if o.present && o.set {
return nil
} else if err == nil {
return NotPresent
}
return err
}
// WasSetElseGet returns the value if present and set, otherwise returns the result of calling the supplied function
//
// if the supplied function is nil and the value is not present and set, returns a default empty value
func (o *Optional[T]) WasSetElseGet(f func() T) T {
if o.present && o.set {
return o.value
} else if f != nil {
return f()
}
return o.emptyValue()
}
// WasSetElsePanic if the value is not present and set, panics with the supplied value, otherwise does nothing
func (o *Optional[T]) WasSetElsePanic(v any) *Optional[T] {
if o.present && o.set {
return o
}
panic(v)
}
// WasSetElseSet if the value is not present and set it is set to the value supplied
func (o *Optional[T]) WasSetElseSet(v T) *Optional[T] {
if !o.present || !o.set {
if isPresent(v) {
o.present = true
o.value = v
} else {
o.present = false
o.value = o.emptyValue()
}
o.set = true
}
return o
}
func (o *Optional[T]) emptyValue() T {
return (Optional[T]{}).value
}
func (o *Optional[T]) clear(set bool) {
o.value = o.emptyValue()
o.present = false
o.set = set
}
func (o *Optional[T]) isString() bool {
return reflect.TypeOf(o.value).Kind() == reflect.String
}
func (o *Optional[T]) callScannable(value interface{}) (bool, error) {
var nv reflect.Value
if !isPresent(o.value) {
rt := reflect.TypeOf(o.value)
if rt.Kind() == reflect.Pointer {
rt = rt.Elem()
}
nv = reflect.New(rt)
} else {
nv = reflect.ValueOf(o.value)
}
anv := nv.Interface()
if sanv, ok := anv.(sql.Scanner); ok {
err := sanv.Scan(value)
if err == nil {
o.value = anv.(T)
o.present = isPresent(anv)
o.set = true
} else {
o.clear(true)
}
return true, err
}
return false, nil
}
// EmptyString returns an empty optional of type string
func EmptyString() *Optional[string] {
return Empty[string]()
}
// EmptyInterface returns an empty optional of type interface{}
func EmptyInterface() *Optional[interface{}] {
return Empty[interface{}]()
}
// EmptyInt returns an empty optional of type int
func EmptyInt() *Optional[int] {
return Empty[int]()
}
// EmptyInt8 returns an empty optional of type int8
func EmptyInt8() *Optional[int8] {
return Empty[int8]()
}
// EmptyInt16 returns an empty optional of type int16
func EmptyInt16() *Optional[int16] {
return Empty[int16]()
}
// EmptyInt32 returns an empty optional of type int32
func EmptyInt32() *Optional[int32] {
return Empty[int32]()
}
// EmptyInt64 returns an empty optional of type int64
func EmptyInt64() *Optional[int64] {
return Empty[int64]()
}
// EmptyUint returns an empty optional of type uint
func EmptyUint() *Optional[uint] {
return Empty[uint]()
}
// EmptyUint8 returns an empty optional of type uint8
func EmptyUint8() *Optional[uint8] {
return Empty[uint8]()
}
// EmptyUint16 returns an empty optional of type uint16
func EmptyUint16() *Optional[uint16] {
return Empty[uint16]()
}
// EmptyUint32 returns an empty optional of type uint32
func EmptyUint32() *Optional[uint32] {
return Empty[uint32]()
}
// EmptyUint64 returns an empty optional of type uint64
func EmptyUint64() *Optional[uint64] {
return Empty[uint64]()
}
// EmptyBool returns an empty optional of type bool
func EmptyBool() *Optional[bool] {
return Empty[bool]()
}
// EmptyFloat32 returns an empty optional of type float32
func EmptyFloat32() *Optional[float32] {
return Empty[float32]()
}
// EmptyFloat64 returns an empty optional of type float64
func EmptyFloat64() *Optional[float64] {
return Empty[float64]()
}
// EmptyByte returns an empty optional of type byte
func EmptyByte() *Optional[byte] {
return Empty[byte]()
}
// EmptyRune returns an empty optional of type rune
func EmptyRune() *Optional[rune] {
return Empty[rune]()
}