Add warning about disk writes/reads to Config
This commit is contained in:
parent
a952490188
commit
06a593df25
@ -54,11 +54,13 @@ type Config interface {
|
|||||||
// not a boolean, it will return fallback.
|
// not a boolean, it will return fallback.
|
||||||
GetBool (key string, fallback bool) (bool, error)
|
GetBool (key string, fallback bool) (bool, error)
|
||||||
// Set sets a value in the user-level config file. If the key is
|
// Set sets a value in the user-level config file. If the key is
|
||||||
// invalid, it returns ErrMalformedKey.
|
// invalid, it returns ErrMalformedKey. Note that *will* cause a write
|
||||||
|
// to disk, and a read from disk for whatever is watching the user file.
|
||||||
Set (key string, value Value) error
|
Set (key string, value Value) error
|
||||||
// Reset removes the value from the user-level config file, resetting it
|
// Reset removes the value from the user-level config file, resetting it
|
||||||
// to what is described by the system-level config files. If the key is
|
// to what is described by the system-level config files. If the key is
|
||||||
// invalid, it returns ErrMalformedKey.
|
// invalid, it returns ErrMalformedKey. Note that *will* cause a write
|
||||||
|
// to disk, and a read from disk for whatever is watching the user file.
|
||||||
Reset (key string) error
|
Reset (key string) error
|
||||||
// OnChange specifies a function to be called whenever a value is
|
// OnChange specifies a function to be called whenever a value is
|
||||||
// changed. The callback is always run within the backend's event loop
|
// changed. The callback is always run within the backend's event loop
|
||||||
|
Loading…
Reference in New Issue
Block a user