umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 13:10:24 +00:00
Code Issues Wiki Activity

Slight docs fix in cowboy_req.erl

Browse source
This commit is contained in:
pmyarchon 2013-07-18 12:16:03 +04:00
parent ddefa33a38
commit 95c915dfaa
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/cowboy_req.erl
View file

@ -791,9 +791,9 @@ body_qs(MaxBodyLength, Req) ->
%% @doc Return data from the multipart parser. %% @doc Return data from the multipart parser.
%% %%
%% Use this function for multipart streaming. For each part in the request, %% Use this function for multipart streaming. For each part in the request,
%% this function returns <em>{headers, Headers}</em> followed by a sequence of %% this function returns <em>{headers, Headers, Req}</em> followed by a sequence of
%% <em>{body, Data}</em> tuples and finally <em>end_of_part</em>. When there %% <em>{body, Data, Req}</em> tuples and finally <em>{end_of_part, Req}</em>. When there
%% is no part to parse anymore, <em>eof</em> is returned. %% is no part to parse anymore, <em>{eof, Req}</em> is returned.
-spec multipart_data(Req) -spec multipart_data(Req)
-> {headers, cowboy:http_headers(), Req} | {body, binary(), Req} -> {headers, cowboy:http_headers(), Req} | {body, binary(), Req}
| {end_of_part | eof, Req} when Req::req(). | {end_of_part | eof, Req} when Req::req().
@ -832,7 +832,7 @@ multipart_data(Req, Length, {more, Parser}) when Length > 0 ->
%% @doc Skip a part returned by the multipart parser. %% @doc Skip a part returned by the multipart parser.
%% %%
%% This function repeatedly calls <em>multipart_data/1</em> until %% This function repeatedly calls <em>multipart_data/1</em> until
%% <em>end_of_part</em> or <em>eof</em> is parsed. %% <em>{end_of_part, Req}</em> or <em>{eof, Req}</em> is parsed.
-spec multipart_skip(Req) -> {ok, Req} when Req::req(). -spec multipart_skip(Req) -> {ok, Req} when Req::req().
multipart_skip(Req) -> multipart_skip(Req) ->
case multipart_data(Req) of case multipart_data(Req) of