go-india / rail Goto Github PK

Right now, we haven't defined custom types for Quota, Class and StationCode fields of Requests. This decision has been taken as we don't want to limit the user's in future in their use of the library.

A proposal is to define custom types for these fields. And since they would be an alias of Go's inbuild types, they can be easily used.

type Quota string
type Class string
type StationCode string

This decision is pending. Discussions are always welcomed.

Right now, the library is built as a system build on both concrete request/response objects. Helpers combine the both of them into one.

But since the request/response objects are building blocks of the helpers, we can separate them out into 2 new sub-packages inside the repo. This will give us a clear usage and better docs.

import (
    "github.com/go-india/rail/req"
    "github.com/go-india/rail/resp"
    "github.com/go-india/rail"
)

The client and its helpers are the ultimate API/Usage of this library.
Other types and objects are building blocks of that.