Setting ResponseHeadersRead

[Syed-RI]

Hi all, bit of a refit noob here... so some questions may seem trivial (apologies)

I can do something like

var client = new HttpClient(); // dirty example for brevity
var response = await client.GetAsync("https://api.example.com", HttpCompletionOption.ResponseHeadersRead);
await using var content = await response.Content.ReadAsStreamAsync();
var result = await JsonSerializer.DeserializeAsync<Foo>(content);

However, in Refit interface I cant set ResponseHeadersRead, what would be equivalent? What Im trying to achieve is to avoid waiting for whole content to be loaded into memory prior deserialisation (think this GetFoo is returning quite large data sets). Also, what would be the difference between these two different methods below? Which one is more performant (relatively speaking)?

public interface IRefitFoo
{
    [Get("/foo")]
    Task<IApiResponse<Foo?>> GetFooAsync();
    
    [Get("/foo")]
    Task<IApiResponse<Stream?>> GetFooStreamAsync();
}

Does Refit fetches all the item first then Deserialises ? Whats the underlying mechanics of the refit implementations? Does is uses GetStringAsync GetStreamAsync or GetAsync ?

[ducman]

Refit does this by default, as seen here.

The Stream is more performant since it uses ReadAsStreamAsync. You can also use HttpResponseMessage which gives you full control of the response.

You can follow the code trail I've linked above to see usage of ReadAsStreamAsync and ReadFromJsonAsync (unsure if there are others) to deserialized the response content.