Skip to content

Commit

Permalink
readme: Clarifications of some options/requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
alexejk committed Aug 8, 2022
1 parent ecb01a6 commit c69dd8d
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ For instance:

- To customize any aspect of `http.Client` used to perform requests, use `HttpClient` option, otherwise `http.DefaultClient` will be used
- To pass custom headers, make use of `Headers` option.
- To not fail parsing when unmapped fields exist in RPC responses, use `SkipUnknownFields(true)` option (default is `false`)

### Argument encoding

Expand All @@ -64,7 +65,7 @@ Arguments to the remote RPC method are passed on as a `*struct`. This struct is
Response is decoded following similar rules to argument encoding.

* Order of fields is important.
* Outer struct should contain exported field for each response parameter.
* Outer struct should contain exported field for each response parameter (it is possible to ignore unknown structs with `SkipUnknownFields` option).
* Structs may contain pointers - they will be initialized if required.

### Field renaming
Expand Down Expand Up @@ -97,6 +98,8 @@ v := &struct {
}{}
```

Similarly, request encoding honors `xmlrpc` tags.

## Building

To build this project, simply run `make all`.
Expand Down

0 comments on commit c69dd8d

Please sign in to comment.