try

README

Explore Usage »

Report Bug · Request Feature

Table of Contents

1. About
2. Why go-try?
3. Getting Started
   • Usage
   • Example
4. Roadmap
5. Contributing
6. License
7. Contact

About

go-try is a package that allows you to use try/catch block in Go.

This project is still in its early stages, so any thoughts and feedback are very welcome!

(back to top)

Why go-try?

Many Go developers get tired of dealing with errors because there are too many errors to handle one by one, which is intuitive and effective, but really annoying.

I've been trying to find out if Go has an error handling method like try/catch, I think that would probably be a lot easier, but unfortunately, I couldn't find any package that's easy to use.

So I tried to make one myself, taking inspiration from the try/catch syntax, then go-try was born!

(back to top)

Getting Started

Installation

go get github.com/ez4o/go-try

Usage

Try(func () {
  ...
  ThrowOnError(ce)
  ...
  ThrowOnError(err)
  ...
}).Catch(func (ce CustomError) {
  ...
}).Catch(func (e error, st *StackTrace) {
  ...
  st.Print()
})

Functions

Name	Description
Try()	Takes func (), wrap your code here!
Catch()	Takes func (any) or func (any, *StackTrace), and it will only accept the error type you have declared. You can accept second parameter, which is the stack trace begin from the last ThrowOnError().
ThrowOnError()	Takes any. Will only throw an error when the parameter is not nil.
st.Print()	If you have declared the second parameter st *StackTrace, you can print the stack trace using st.Print().

Example

Let's say you want to fetch JSON from a url and unmarshal it, you can simply write it like this:

import (
  "encoding/json"
  "fmt"
  "io/ioutil"
  "net/http"
    
  . "github.com/ez4o/go-try"
)

func main() {
  Try(func() {
    resp, err := http.Get("https://jsonplaceholder.typicode.com/posts")
    ThrowOnError(err)
    defer resp.Body.Close()
    
    b, err := ioutil.ReadAll(resp.Body)
    ThrowOnError(err)

    var data []map[string]interface{}
    err = json.Unmarshal(b, &data)
    ThrowOnError(err)

    fmt.Println(data)
  }).Catch(func(e error, st *StackTrace) {
    fmt.Println(e)
    st.Print()
  })
}

For more examples, head over to https://github.com/ez4o/go-try/tree/main/.examples!

(back to top)

Roadmap

• Implement catching errors of different types.
• Tests
• CI

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/amazing-feature)
3. Commit your Changes with Conventional Commits
4. Push to the Branch (git push origin feat/amazing-feature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Author

• HSING-HAN, WU (Xyphuz)
  • Mail me: xyphuzwu@gmail.com
  • About me: https://about.xyphuz.com
  • GitHub: https://github.com/wst24365888

Project Link

• https://github.com/ez4o/go-try

(back to top)

Documentation

Index

• func ThrowOnError(err any)
• type Exception
  • func Try(f func()) *Exception
  • func (e *Exception) Catch(f any) *Exception
• type StackInfo
  • func (si *StackInfo) String() string
• type StackTrace
  • func (st *StackTrace) Print()

Functions

func ThrowOnError

func ThrowOnError(err any)

Types

type Exception

type Exception struct {
	// contains filtered or unexported fields
}

func Try

func Try(f func()) *Exception

func (*Exception) Catch

func (e *Exception) Catch(f any) *Exception

type StackInfo

type StackInfo struct {
	// contains filtered or unexported fields
}

func (*StackInfo) String

func (si *StackInfo) String() string

type StackTrace

type StackTrace struct {
	// contains filtered or unexported fields
}

func (*StackTrace) Print

func (st *StackTrace) Print()