From 7e2ba16f2071f3d15eedb8b0b0ba0205adbeee1e Mon Sep 17 00:00:00 2001 From: Avuluri Venkata Sai Reddy Date: Sun, 29 Jan 2023 23:18:21 +0530 Subject: [PATCH] update readme, fix formatting --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index da06955..3174f6c 100644 --- a/README.md +++ b/README.md @@ -814,27 +814,27 @@ There are other scenarios in which it is common to find `nil` values that can ca ```go type App struct { - Cache *KVCache + Cache *KVCache } type KVCache struct { mtx sync.RWMutex - store map[string]string + store map[string]string } func (cache *KVCache) Add(key, value string) { cache.mtx.Lock() defer cache.mtx.Unlock() - cache.store[key] = value + cache.store[key] = value } ``` This code is absolutely fine. However, the danger is that our `App` can be initialised incorrectly, without initialising the `Cache` property within. Should the following code be invoked, our application will panic: ```go - app := App{} - app.Cache.Add("panic", "now") +app := App{} +app.Cache.Add("panic", "now") ``` The `Cache` property has never been initialised and is therefore a `nil` pointer. Thus, invoking the `Add` method like we did here will cause a panic, with the following message: @@ -845,14 +845,14 @@ Instead, we can turn the `Cache` property of our `App` structure into a private ```go type App struct { - cache *KVCache + cache *KVCache } func (app *App) Cache() *KVCache { - if app.cache == nil { - app.cache = NewKVCache() - } - return app.cache + if app.cache == nil { + app.cache = NewKVCache() + } + return app.cache } ```