Difuse/luci
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Rewrote the API-documentation for luci.json

Browse source
This commit is contained in:
Steven Barth 2008-08-27 17:49:52 +00:00
parent a4761ed42f
commit 9a8eb7fce6
1 changed files with 15 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
libs/json/luasrc/json.lua
View file

@ -55,6 +55,7 @@ local next = next
local getmetatable = getmetatable local getmetatable = getmetatable
--- LuCI JSON-Library
module "luci.json" module "luci.json"
--- Null replacement function --- Null replacement function
@ -63,12 +64,15 @@ function null()
return null return null
end end
--- JSON-Encoder
-- @class module
-- @cstyle instance
-- @name luci.json.Encoder
Encoder = util.class() Encoder = util.class()
--- Creates a new Encoder. --- Creates a new Encoder.
-- @param data Data to be encoded. -- @param data Lua-Object to be encoded.
-- @param buffersize Buffersize of returned data. -- @param buffersize Blocksize of returned data source.
-- @param fastescape Use non-standard escaping (don't escape control chars) -- @param fastescape Use non-standard escaping (don't escape control chars)
function Encoder.__init__(self, data, buffersize, fastescape) function Encoder.__init__(self, data, buffersize, fastescape)
self.data = data self.data = data
@ -79,7 +83,7 @@ function Encoder.__init__(self, data, buffersize, fastescape)
getmetatable(self).__call = Encoder.source getmetatable(self).__call = Encoder.source
end end
--- Create an LTN12 source from the encoder object --- Create an LTN12 source providing the encoded JSON-Data.
-- @return LTN12 source -- @return LTN12 source
function Encoder.source(self) function Encoder.source(self)
local source = coroutine.create(self.dispatch) local source = coroutine.create(self.dispatch)
@ -207,17 +211,20 @@ Encoder.parsers = {
} }
--- JSON-Decoder
-- @class module
-- @cstyle instance
-- @name luci.json.Decoder
Decoder = util.class() Decoder = util.class()
--- Create a new Decoder object. --- Create a new Decoder object.
-- @param customnull User luci.json.null instead of nil -- @param customnull Use luci.json.null instead of nil
function Decoder.__init__(self, customnull) function Decoder.__init__(self, customnull)
self.cnull = customnull self.cnull = customnull
getmetatable(self).__call = Decoder.sink getmetatable(self).__call = Decoder.sink
end end
--- Create an LTN12 sink from the decoder object. --- Create an LTN12 sink from the decoder object which accepts the JSON-Data.
-- @return LTN12 sink -- @return LTN12 sink
function Decoder.sink(self) function Decoder.sink(self)
local sink = coroutine.create(self.dispatch) local sink = coroutine.create(self.dispatch)
@ -227,7 +234,7 @@ function Decoder.sink(self)
end end
--- Get the decoded data packets --- Get the decoded data packets after the rawdata has been sent to the sink.
-- @return Decoded data -- @return Decoded data
function Decoder.get(self) function Decoder.get(self)
return self.data return self.data