Update doc [ci skip]

This commit is contained in:
Alexey Melnichuk 2017-07-13 10:29:19 +03:00
parent bb5fa08d89
commit 36ea4c532f

View File

@ -367,6 +367,87 @@ function setopt_progressfunction() end
-- --
function setopt_progressfunction() end function setopt_progressfunction() end
--- Set seek callback function.
--
-- A callback accepting two or three parameters.
-- The first is the seek context if any, the second is the `origin` value
-- same as in file.seek function from io library. Can be (`cur`, `set` and `end`).
-- The third parameter is offset or position in input stream.
-- If stream can not be seeking and need stop current transfer operation
-- function have to raise Lua error or returns `nil` and error message.
-- To indicate success function have to return any truthy value
-- In other case Function must return `true` or `1` or nothing to continue operation.
-- False value indicate that while the seek failed, libcurl is free to work
-- around the problem if possible.
--
-- !!! NOTE !!! This is differents form libcurl API by swapping parameters in callback.
-- It done to be compatiable with Lua io library.
--
-- @tparam function seek
-- @param[opt] context seek context
-- @return[1] self
--
function setopt_seekfunction() end
--- Set seek callback function.
--
-- This call same as easy:setopt_seekfunction(stream.seek, seek)
--
-- @tparam object stream
-- @return[1] self
--
function setopt_seekfunction() end
--- Set debug callback function.
--
-- A callback accepting two or three parameters.
-- The first is the debug context if any, the second is the `data_type` value
-- which represent what kinde of data is passed. This value can be one of
-- constant `INFO_TEXT`, `INFO_HEADER_IN`, `INFO_HEADER_OUT`, `INFO_DATA_IN`,
-- `INFO_DATA_OUT`, `INFO_SSL_DATA_IN`, `INFO_SSL_DATA_OUT`.
-- The third parameter is data itself.
-- Any errors and returning values from this callback are ignored.
--
-- @tparam function debug
-- @param[opt] context debug context
-- @return[1] self
--
function setopt_debugfunction() end
--- Set debug callback function.
--
-- This call same as easy:setopt_debugfunction(debug.debug, debug)
--
-- @tparam object debug
-- @return[1] self
--
function setopt_debugfunction() end
--- Set match callback function.
--
-- A callback accepting two or three parameters.
-- The first is the match context if any, the second is the pattern string,
-- the third is the string to match to pattern.
-- Function must return truthy value to indicate that string match to pattern.
-- If function raise error or return nil and error message then it indicate
-- that curl should interrupt current transfer operation.
-- False value indicate that strind does not match to pattern
--
-- @tparam function match
-- @param[opt] context match context
-- @return[1] self
--
function setopt_fnmatch_function() end
--- Set match callback function.
--
-- This call same as easy:setopt_fnmatch_function(match.match, match)
--
-- @tparam object match
-- @return[1] self
--
function setopt_fnmatch_function() end
--- Set HTTP multipart/formdata. --- Set HTTP multipart/formdata.
-- --
-- Caller does not have to save data. -- Caller does not have to save data.