https://github.com/followtheprocess/pointer

Work fearlessly with pointers in Go
https://github.com/followtheprocess/pointer

Last synced: about 1 month ago
JSON representation

Work fearlessly with pointers in Go

• Host: GitHub
• URL: https://github.com/followtheprocess/pointer
• Owner: FollowTheProcess
• License: mit
• Created: 2023-05-12T16:55:22.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-21T20:38:15.000Z (3 months ago)
• Last Synced: 2024-08-21T22:51:29.555Z (3 months ago)
• Language: Go
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pointer

[![License](https://img.shields.io/github/license/FollowTheProcess/pointer)](https://github.com/FollowTheProcess/pointer)

[![Go Reference](https://pkg.go.dev/badge/github.com/FollowTheProcess/pointer.svg)](https://pkg.go.dev/github.com/FollowTheProcess/pointer)

[![Go Report Card](https://goreportcard.com/badge/github.com/FollowTheProcess/pointer)](https://goreportcard.com/report/github.com/FollowTheProcess/pointer)

[![GitHub](https://img.shields.io/github/v/release/FollowTheProcess/pointer?logo=github&sort=semver)](https://github.com/FollowTheProcess/pointer)

[![CI](https://github.com/FollowTheProcess/pointer/workflows/CI/badge.svg)](https://github.com/FollowTheProcess/pointer/actions?query=workflow%3ACI)

[![codecov](https://codecov.io/gh/FollowTheProcess/pointer/branch/main/graph/badge.svg)](https://codecov.io/gh/FollowTheProcess/pointer)

***Work fearlessly with pointers in Go***

## Project Description

`package pointer` is a *tiny*, simple and obvious library helping you to always work safely with pointers and avoid the dreaded `nil pointer dereference` 🚀

## Installation

To use this project in your code:

```shell

go get github.com/FollowTheProcess/pointer@latest

```

And then simply:

```go

import "github.com/FollowTheProcess/pointer"

```

## Quickstart

Using `pointer` is so easy, you already know how to do it!

```go

import (

    "fmt"

    "github.com/FollowTheProcess/pointer"

)

func main() {

    var s *string // nil

    // More code here, you've forgotten `s` is nil by now!

    // but pointer has you covered!

    str := pointer.Or(s, "hello")

    fmt.Println(str) // "hello"

    // We just want the zero value if it's nil

    fmt.Println(pointer.OrDefault(s)) // ""

}

```

`pointer.Or` will return the pointer it's passed in **only** if it's not nil! Otherwise you'll get back the value you provided.

If you just want the zero value instead, use `pointer.OrDefault`

### Credits

This package was created with [copier] and the [FollowTheProcess/go_copier] project template.

[copier]: https://copier.readthedocs.io/en/stable/

[FollowTheProcess/go_copier]: https://github.com/FollowTheProcess/go_copier