mirror of
https://github.com/sourcegraph/jsonrpc2.git
synced 2026-06-16 20:20:03 +02:00
ae88a5e7c0
With this commit, the JSON encoding of `Request` always omits the params
member when calling `Conn.Call`, `Conn.DispatchCall`, or `Conn.Notify`
with the `params` argument set to `nil`. This change also removes the
`OmitNilParams` call option that was added in commit 8012d496 (#62).
As of this commit, if users desire to send a JSON-RPC request with a
`params` value of `null`, then they may do so by explicitly setting the
`params` argument of `Conn.Call`/`Conn.DispatchCall`/`Conn.Notify` to
`json.RawMessage("null")`.
48 lines
1.4 KiB
Go
48 lines
1.4 KiB
Go
package jsonrpc2
|
|
|
|
// CallOption is an option that can be provided to (*Conn).Call to
|
|
// configure custom behavior. See Meta.
|
|
type CallOption interface {
|
|
apply(r *Request) error
|
|
}
|
|
|
|
type callOptionFunc func(r *Request) error
|
|
|
|
func (c callOptionFunc) apply(r *Request) error { return c(r) }
|
|
|
|
// Meta returns a call option which attaches the given meta object to
|
|
// the JSON-RPC 2.0 request (this is a Sourcegraph extension to JSON
|
|
// RPC 2.0 for carrying metadata).
|
|
func Meta(meta interface{}) CallOption {
|
|
return callOptionFunc(func(r *Request) error {
|
|
return r.SetMeta(meta)
|
|
})
|
|
}
|
|
|
|
// ExtraField returns a call option which attaches the given name/value pair to
|
|
// the JSON-RPC 2.0 request. This can be used to add arbitrary extensions to
|
|
// JSON RPC 2.0.
|
|
func ExtraField(name string, value interface{}) CallOption {
|
|
return callOptionFunc(func(r *Request) error {
|
|
return r.SetExtraField(name, value)
|
|
})
|
|
}
|
|
|
|
// PickID returns a call option which sets the ID on a request. Care must be
|
|
// taken to ensure there are no conflicts with any previously picked ID, nor
|
|
// with the default sequence ID.
|
|
func PickID(id ID) CallOption {
|
|
return callOptionFunc(func(r *Request) error {
|
|
r.ID = id
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// StringID returns a call option that instructs the request ID to be set as a
|
|
// string.
|
|
func StringID() CallOption {
|
|
return callOptionFunc(func(r *Request) error {
|
|
r.ID.IsString = true
|
|
return nil
|
|
})
|
|
}
|