Not nullable body on success about sandwich HOT 6 CLOSED

From my perspective 204 should be always by design. So when i want to handle 204 i just don't require any response type (in Sandwich that could be represented by a Unit type maybe? (I'm not 100% sure about that, but maybe Sandwich could allow 204 as a success only if return type is Unit? Is that even possible in kotlin, not sure here :) ).

Or maybe different response handling type, something like NoContentApiResponse instead of ApiResponse. That seems to me like fine explicit solution to that. That way programmer always have to explicitly declare that they do not expect body.

from sandwich.

Hi, @jakoss
Your issue is very worth agenda to discuss in this APIs.
The data property in the ApiResponse.Success will be null if the response has been succeeded, but the body data is empty (e.g., 204-No Content). So I designed following the Retrofit's interfaces at the beginning.

I was thought of implementing another expression for handling the empty body response like onComplete and changing the type of the data to non-nullable. But it was a little questionable whether it is efficient to create a new expression for handling empty body responses in another way because we can handle both cases in the onSuccess expression.

If you have an idea for handling the empty body cases, I hope to get any feedback for supporting better interfaces! :)

from sandwich.

You're right. :) And moreover, we don't require to handle the data when the 204 response case, which means also we don't need to check the nullability. (For the 204 response case, we don't need to access the data property at all).

I'm considering changing the type of the data property to non-null, and It will throw NoContentException when trying to access the body is null. Also, I'm considering implementing onComplete scope function to handle which has no response receivers for processing only the no-content case.

Thanks for sharing your feedback :)

from sandwich.

Throwing on body access while in 204 seems fine. Like I said, it should always be by design anyway 😁

from sandwich.

@jakoss
This feature has been included in the 1.2.0-SNAPSHOT and it will be released on the next version.
Thank you for your discussion and issue! 👍

from sandwich.

Released a new stable 1.2.0. 🎉

from sandwich.