annotate vendor/gopkg.in/yaml.v3/writerc.go @ 77:e1f9fda6986a draft

Just a documentation update Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Sun, 10 Dec 2023 23:57:40 +0000
parents d8727551f403
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
74
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
1 //
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
2 // Copyright (c) 2011-2019 Canonical Ltd
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
3 // Copyright (c) 2006-2010 Kirill Simonov
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
4 //
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
5 // Permission is hereby granted, free of charge, to any person obtaining a copy of
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
6 // this software and associated documentation files (the "Software"), to deal in
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
7 // the Software without restriction, including without limitation the rights to
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
8 // use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
9 // of the Software, and to permit persons to whom the Software is furnished to do
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
10 // so, subject to the following conditions:
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
11 //
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
12 // The above copyright notice and this permission notice shall be included in all
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
13 // copies or substantial portions of the Software.
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
14 //
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
21 // SOFTWARE.
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
22
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
23 package yaml
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
24
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
25 // Set the writer error and return false.
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
26 func yaml_emitter_set_writer_error(emitter *yaml_emitter_t, problem string) bool {
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
27 emitter.error = yaml_WRITER_ERROR
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
28 emitter.problem = problem
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
29 return false
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
30 }
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
31
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
32 // Flush the output buffer.
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
33 func yaml_emitter_flush(emitter *yaml_emitter_t) bool {
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
34 if emitter.write_handler == nil {
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
35 panic("write handler not set")
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
36 }
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
37
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
38 // Check if the buffer is empty.
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
39 if emitter.buffer_pos == 0 {
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
40 return true
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
41 }
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
42
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
43 if err := emitter.write_handler(emitter, emitter.buffer[:emitter.buffer_pos]); err != nil {
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
44 return yaml_emitter_set_writer_error(emitter, "write error: "+err.Error())
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
45 }
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
46 emitter.buffer_pos = 0
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
47 return true
d8727551f403 The Empress (III)
yakumo.izuru
parents:
diff changeset
48 }