Conventions

Structure Conventions

Types used in reqwest requests get moved into a child module named reqwest_types.
- The exception to this rule is when a type has a use in the public parts of the library, and it can serialize and deserialize correctly.
As sometimes a request needs to repeat due to an invalid x-csrf-token, a "trampolining" approach is used as async_recursion complicates the type signature. Due to this, all functions that require an x-csrf-token have their private method in an internal module. This module can be, but does not need to be, in a separate file. The public method gets called, which calls xxx_internal() (xxx being the public method name) up to two times.
- (e.g., external::item_details() is the public version of item_details_internal())

Naming Conventions

Structs used as a generic when calling .json() (where the status code is 200) are suffixed with -Response (only in cases where the status code is 200).
- (e.g., ItemDetailsResponse)
Structs used as a generic when calling .json() (where the status code is NOT 200) are suffixed with -ErrorResponse.
- (e.g., ToggleSaleErrorResponse)
Structs/Enums used inside structs suffixed with -Response are suffixed with -Raw.
- (e.g., ItemDetailsRaw)
Structs used as, or in, a body to a reqwest request are suffixed with -ReqBody.
- (e.g., ItemDetailsReqBody)
Structs/Enums used inside structs suffixed with -ReqBody are suffixed with -Req.
- (e.g., ItemArgsReq)
Structs/Enums used as, or in, a type for a function parameter are suffixed with -Args.
- (e.g., ItemArgs)

Misc Conventions

All methods that make a call to an endpoint must include a doc example and a crate example.