From 27dd9d75f9e920150353db85cb126f2c83e89140 Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Mon, 30 Apr 2018 14:45:25 +0200 Subject: [PATCH] documentation: regenerate documents from current code base Signed-off-by: Jo-Philipp Wich --- documentation/api/index.html | 21 +- documentation/api/modules/luci.dispatcher.html | 54 ++- documentation/api/modules/luci.http.html | 437 +++++++++++++++++++++- documentation/api/modules/luci.i18n.html | 10 +- documentation/api/modules/luci.ip.cidr.html | 10 +- documentation/api/modules/luci.ip.html | 10 +- documentation/api/modules/luci.json.html | 10 +- documentation/api/modules/luci.jsonc.html | 10 +- documentation/api/modules/luci.jsonc.parser.html | 10 +- documentation/api/modules/luci.model.ipkg.html | 10 +- documentation/api/modules/luci.model.uci.html | 97 ++++- documentation/api/modules/luci.rpcc.html | 10 +- documentation/api/modules/luci.rpcc.ruci.html | 10 +- documentation/api/modules/luci.sys.html | 10 +- documentation/api/modules/luci.sys.init.html | 10 +- documentation/api/modules/luci.sys.iptparser.html | 10 +- documentation/api/modules/luci.sys.net.html | 10 +- documentation/api/modules/luci.sys.process.html | 10 +- documentation/api/modules/luci.sys.user.html | 10 +- documentation/api/modules/luci.sys.wifi.html | 10 +- documentation/api/modules/luci.util.html | 255 +++++++++---- documentation/api/modules/nixio.CHANGELOG.html | 10 +- documentation/api/modules/nixio.CryptoHash.html | 10 +- documentation/api/modules/nixio.File.html | 10 +- documentation/api/modules/nixio.README.html | 10 +- documentation/api/modules/nixio.Socket.html | 10 +- documentation/api/modules/nixio.TLSContext.html | 10 +- documentation/api/modules/nixio.TLSSocket.html | 10 +- documentation/api/modules/nixio.UnifiedIO.html | 10 +- documentation/api/modules/nixio.bin.html | 10 +- documentation/api/modules/nixio.bit.html | 10 +- documentation/api/modules/nixio.crypto.html | 10 +- documentation/api/modules/nixio.fs.html | 10 +- documentation/api/modules/nixio.html | 10 +- 34 files changed, 828 insertions(+), 326 deletions(-) diff --git a/documentation/api/index.html b/documentation/api/index.html index c762b9b0e..5e3f3c211 100644 --- a/documentation/api/index.html +++ b/documentation/api/index.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • @@ -214,22 +210,17 @@ - luci.http.protocol - - - - - luci.http.protocol.conditionals + luci.http.conditionals - luci.http.protocol.date + luci.http.date - luci.http.protocol.mime + luci.http.mime diff --git a/documentation/api/modules/luci.dispatcher.html b/documentation/api/modules/luci.dispatcher.html index 4ae88fe61..e4b12e676 100644 --- a/documentation/api/modules/luci.dispatcher.html +++ b/documentation/api/modules/luci.dispatcher.html @@ -41,19 +41,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • @@ -321,7 +317,6 @@ Create a CBI form model dispatching target. Fetch or create a dispatching node without setting the target module or - enabling the node. @@ -333,6 +328,13 @@ Dispatch an HTTP request. + lookup (...) + + +Lookup node in dispatching tree. + + + modifier (func, order) @@ -857,8 +859,8 @@ Create a CBI form model dispatching target. Fetch or create a dispatching node without setting the target module or - -enabling the node. +enabling the node. +

    Parameters

    @@ -914,6 +916,38 @@ Dispatch an HTTP request. +
    lookup (...)
    +
    + + +Lookup node in dispatching tree. + + + +

    Parameters

    +
      + +
    • + ...: Virtual path +
      • + +
    + + + + + + +

    Return value:

    +Node object, canonical url or nil if the path was not found. + + + +
    + + + +
    modifier (func, order)
    diff --git a/documentation/api/modules/luci.http.html b/documentation/api/modules/luci.http.html index ea04fc236..d75863fa6 100644 --- a/documentation/api/modules/luci.http.html +++ b/documentation/api/modules/luci.http.html @@ -41,19 +41,15 @@
  • luci.http
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • @@ -256,7 +252,6 @@ Get the value of a certain HTTP-Cookie. Get the value of a certain HTTP environment variable - or the environment table itself. @@ -268,6 +263,20 @@ Send a HTTP-Header. + mimedecode_message_body (src, msg, filecb) + + +Decode a mime encoded http message body with multipart/form-data Content-Type. + + + + parse_message_body (src, msg, filecb) + + +Try to extract and decode a http message body from the given ltn12 source. + + + prepare_content (mime) @@ -311,6 +320,44 @@ Set the HTTP status code and status message. + urldecode (str, no_plus) + + +Return the URL-decoded equivalent of a string. + + + + urldecode_message_body (src, msg) + + +Decode an urlencoded http message body with application/x-www-urlencoded +Content-Type. + + + + urldecode_params (url, tbl) + + +Extract and split urlencoded data pairs, separated bei either "&" or ";" +from given url or string. + + + + urlencode (str) + + +Return the URL-encoded equivalent of a string. + + + + urlencode_params (tbl) + + +Encode each key-value-pair in given table to x-www-urlencoded format, +separated by "&". + + + write (content, src_err) @@ -377,7 +424,6 @@ Encoded HTTP query string Close the HTTP-Connection. - @@ -527,8 +573,8 @@ String containing cookie data Get the value of a certain HTTP environment variable - -or the environment table itself. +or the environment table itself. +

    Parameters

    @@ -588,6 +634,135 @@ Send a HTTP-Header. +
    mimedecode_message_body (src, msg, filecb)
    +
    + + +Decode a mime encoded http message body with multipart/form-data Content-Type. + +Stores all extracted data associated with its parameter name +in the params table within the given message object. Multiple parameter +values are stored as tables, ordinary ones as strings. + +If an optional file callback function is given then it is feeded with the +file contents chunk by chunk and only the extracted file name is stored +within the params table. The callback function will be called subsequently +with three arguments: + o Table containing decoded (name, file) and raw (headers) mime header data + o String value containing a chunk of the file data + o Boolean which indicates wheather the current chunk is the last one (eof) + + + +

    Parameters

    +
      + +
    • + src: Ltn12 source function +
      • + +
    • + msg: HTTP message object +
      • + +
    • + filecb: File callback function (optional) +
      • + +
    + + + + + + +

    Return values:

    +
      + +
    1. Value indicating successful operation (not nil means "ok") + +
    2. String containing the error if unsuccessful + +
    + + + +

    See also:

    + + +
    + + + + +
    parse_message_body (src, msg, filecb)
    +
    + + +Try to extract and decode a http message body from the given ltn12 source. +This function will examine the Content-Type within the given message object +to select the appropriate content decoder. + +Currently the application/x-www-urlencoded and application/form-data +mime types are supported. If the encountered content encoding can't be +handled then the whole message body will be stored unaltered as "content" +property within the given message object. + + + +

    Parameters

    +
      + +
    • + src: Ltn12 source function +
      • + +
    • + msg: HTTP message object +
      • + +
    • + filecb: File data callback (optional, see mimedecode_message_body()) +
      • + +
    + + + + + + +

    Return values:

    +
      + +
    1. Value indicating successful operation (not nil means "ok") + +
    2. String containing the error if unsuccessful + +
    + + + +

    See also:

    + + +
    + + + +
    prepare_content (mime)
    @@ -764,6 +939,243 @@ Set the HTTP status code and status message. +
    urldecode (str, no_plus)
    +
    + + +Return the URL-decoded equivalent of a string. + + + +

    Parameters

    +
      + +
    • + str: URL-encoded string +
      • + +
    • + no_plus: Don't decode + to " " +
      • + +
    + + + + + + +

    Return value:

    +URL-decoded string + + + +

    See also:

    + + +
    + + + + +
    urldecode_message_body (src, msg)
    +
    + + +Decode an urlencoded http message body with application/x-www-urlencoded +Content-Type. + +Stores all extracted data associated with its parameter name in the params +table within the given message object. Multiple parameter values are stored +as tables, ordinary ones as strings. + + + +

    Parameters

    +
      + +
    • + src: Ltn12 source function +
      • + +
    • + msg: HTTP message object +
      • + +
    + + + + + + +

    Return values:

    +
      + +
    1. Value indicating successful operation (not nil means "ok") + +
    2. String containing the error if unsuccessful + +
    + + + +

    See also:

    + + +
    + + + + +
    urldecode_params (url, tbl)
    +
    + + +Extract and split urlencoded data pairs, separated bei either "&" or ";" +from given url or string. Returns a table with urldecoded values. + +Simple parameters are stored as string values associated with the parameter +name within the table. Parameters with multiple values are stored as array +containing the corresponding values. + + + +

    Parameters

    +
      + +
    • + url: The url or string which contains x-www-urlencoded form data +
      • + +
    • + tbl: Use the given table for storing values (optional) +
      • + +
    + + + + + + +

    Return value:

    +Table containing the urldecoded parameters + + + +

    See also:

    + + +
    + + + + +
    urlencode (str)
    +
    + + +Return the URL-encoded equivalent of a string. + + + +

    Parameters

    +
      + +
    • + str: Source string +
      • + +
    + + + + + + +

    Return value:

    +URL-encoded string + + + +

    See also:

    + + +
    + + + + +
    urlencode_params (tbl)
    +
    + + +Encode each key-value-pair in given table to x-www-urlencoded format, +separated by "&". + +Tables are encoded as parameters with multiple values by repeating the +parameter name with each value. + + + +

    Parameters

    +
      + +
    • + tbl: Table with the values +
      • + +
    + + + + + + +

    Return value:

    +String containing encoded values + + + +

    See also:

    + + +
    + + + +
    write (content, src_err)
    @@ -771,7 +1183,8 @@ Set the HTTP status code and status message. Send a chunk of content data to the client. This function is as a valid LTN12 sink. -If the content chunk is nil this function will automatically invoke close. +If the content chunk is nil this function will automatically invoke close. +

    Parameters

    diff --git a/documentation/api/modules/luci.i18n.html b/documentation/api/modules/luci.i18n.html index 0111cb200..3f0738bf1 100644 --- a/documentation/api/modules/luci.i18n.html +++ b/documentation/api/modules/luci.i18n.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • luci.i18n
    • diff --git a/documentation/api/modules/luci.ip.cidr.html b/documentation/api/modules/luci.ip.cidr.html index 5a2b06ec6..50633a773 100644 --- a/documentation/api/modules/luci.ip.cidr.html +++ b/documentation/api/modules/luci.ip.cidr.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.ip.html b/documentation/api/modules/luci.ip.html index 1f89626fa..fc13e31e5 100644 --- a/documentation/api/modules/luci.ip.html +++ b/documentation/api/modules/luci.ip.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.json.html b/documentation/api/modules/luci.json.html index 761bd6e7e..db2d1da3f 100644 --- a/documentation/api/modules/luci.json.html +++ b/documentation/api/modules/luci.json.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.jsonc.html b/documentation/api/modules/luci.jsonc.html index f82eb406c..79deb933d 100644 --- a/documentation/api/modules/luci.jsonc.html +++ b/documentation/api/modules/luci.jsonc.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.jsonc.parser.html b/documentation/api/modules/luci.jsonc.parser.html index e8e145f43..709cb9afc 100644 --- a/documentation/api/modules/luci.jsonc.parser.html +++ b/documentation/api/modules/luci.jsonc.parser.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.model.ipkg.html b/documentation/api/modules/luci.model.ipkg.html index 921153c98..a0af3187b 100644 --- a/documentation/api/modules/luci.model.ipkg.html +++ b/documentation/api/modules/luci.model.ipkg.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.model.uci.html b/documentation/api/modules/luci.model.uci.html index c84d1eb0e..77a81fd46 100644 --- a/documentation/api/modules/luci.model.uci.html +++ b/documentation/api/modules/luci.model.uci.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • @@ -310,6 +306,13 @@ Get the directory for uncomitted changes. + Cursor:get_session_id () + + +Get the effective session ID. + + + Cursor:load (config) @@ -366,6 +369,13 @@ Set the directory for uncommited changes. + Cursor:set_session_id (id) + + +Set the effective session ID. + + + Cursor:substate () @@ -631,8 +641,8 @@ Delete all sections of a given type that match certain criteria.
  • - comparator: Function that will be called for each section and -returns a boolean whether to delete the current section (optional) + comparator: Function that will be called for each section and returns + a boolean whether to delete the current section (optional)
    • @@ -903,8 +913,8 @@ Get an option or list and return values as table.

    Return value:

    -table. If the option was not found, you will simply get - an empty table. +table. If the option was not found, you will simply get an empty + table. @@ -936,6 +946,29 @@ Save directory +
    Cursor:get_session_id ()
    +
    + + +Get the effective session ID. + + + + + + + + +

    Return value:

    +String containing the session ID + + + +
    + + + +
    Cursor:load (config)
    @@ -1222,7 +1255,8 @@ has the same effect as deleting the option.
  • - value: value or table. Raw values will become a single item table. + value: Value or table. Non-table values will be set as single + item UCI list.
    • @@ -1274,14 +1308,47 @@ Boolean whether operation succeeded +
    Cursor:set_session_id (id)
    +
    + + +Set the effective session ID. + + + +

    Parameters

    +
      + +
    • + id: String containing the session ID to set +
      • + +
    + + + + + + +

    Return value:

    +Boolean whether operation succeeded + + + +
    + + + +
    Cursor:substate ()
    -Create a sub-state of this cursor. The sub-state is tied to the parent +Create a sub-state of this cursor. -curser, means it the parent unloads or loads configs, the sub state will -do so as well. +The sub-state is tied to the parent curser, means it the parent unloads or +loads configs, the sub state will do so as well. + diff --git a/documentation/api/modules/luci.rpcc.html b/documentation/api/modules/luci.rpcc.html index f7cb02048..18065788b 100644 --- a/documentation/api/modules/luci.rpcc.html +++ b/documentation/api/modules/luci.rpcc.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.rpcc.ruci.html b/documentation/api/modules/luci.rpcc.ruci.html index 203779ce7..7348f1932 100644 --- a/documentation/api/modules/luci.rpcc.ruci.html +++ b/documentation/api/modules/luci.rpcc.ruci.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.sys.html b/documentation/api/modules/luci.sys.html index 860c5fba2..6342a51d5 100644 --- a/documentation/api/modules/luci.sys.html +++ b/documentation/api/modules/luci.sys.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.sys.init.html b/documentation/api/modules/luci.sys.init.html index 596fb7cd1..e2c51f953 100644 --- a/documentation/api/modules/luci.sys.init.html +++ b/documentation/api/modules/luci.sys.init.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.sys.iptparser.html b/documentation/api/modules/luci.sys.iptparser.html index 122afcc2a..5928281cf 100644 --- a/documentation/api/modules/luci.sys.iptparser.html +++ b/documentation/api/modules/luci.sys.iptparser.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.sys.net.html b/documentation/api/modules/luci.sys.net.html index 09cef175f..e7802bb24 100644 --- a/documentation/api/modules/luci.sys.net.html +++ b/documentation/api/modules/luci.sys.net.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.sys.process.html b/documentation/api/modules/luci.sys.process.html index 9c4f0a540..ffe09bdc2 100644 --- a/documentation/api/modules/luci.sys.process.html +++ b/documentation/api/modules/luci.sys.process.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.sys.user.html b/documentation/api/modules/luci.sys.user.html index 37126dd92..04f8bf02b 100644 --- a/documentation/api/modules/luci.sys.user.html +++ b/documentation/api/modules/luci.sys.user.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.sys.wifi.html b/documentation/api/modules/luci.sys.wifi.html index eb1f6b31d..6c893244c 100644 --- a/documentation/api/modules/luci.sys.wifi.html +++ b/documentation/api/modules/luci.sys.wifi.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/luci.util.html b/documentation/api/modules/luci.util.html index 70d27d331..d3d45a180 100644 --- a/documentation/api/modules/luci.util.html +++ b/documentation/api/modules/luci.util.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • @@ -275,13 +271,6 @@ This is a coroutine-safe drop-in replacement for Lua's "xpcall"-function - dtable () - - -Create a dynamic table which automatically creates subtables. - - - dumptable (t, maxdepth) @@ -349,7 +338,6 @@ Returns the absolute path to LuCI base directory. Parse certain units from the given string and return the canonical integer - value or 0 if the unit is unknown. @@ -379,7 +367,6 @@ Restore data previously serialized with serialize_data(). Recursively serialize given data to lua code, suitable for restoring - with loadstring(). @@ -392,11 +379,17 @@ Convert data structure to JSON + shellquote (value) + + +Safely quote value for use in shell commands. + + + spairs (t, f) Return a key, value iterator which returns the values sorted according to - the provided callback function. @@ -405,7 +398,6 @@ the provided callback function. Splits given string on a defined separator sequence and return a table - containing the resulting substrings. @@ -428,7 +420,6 @@ Strip HTML tags from given string. Create a new or get an already existing thread local store associated with - the current active coroutine. @@ -454,6 +445,20 @@ Update values in given table with the values from the second given table. + urldecode (str, decode_plus) + + +Decode an URL-encoded string - optionally decoding the "+" sign to space. + + + + urlencode (str) + + +URL-encode given string. + + + vspairs (t) @@ -549,7 +554,8 @@ Classes can inherit member functions and values from a base class. Class can be instantiated by calling them. All parameters will be passed to the __init__ function of this class - if such a function exists. The __init__ function must be used to set any object parameters that are not shared -with other objects of this class. Any return values will be ignored. +with other objects of this class. Any return values will be ignored. +

    Parameters

    @@ -728,8 +734,8 @@ Checks whether the given table contains the given value.

    Return value:

    -number indicating the first index at which the given value occurs - within table or false. +Number indicating the first index at which the given value occurs + within table or false. @@ -766,7 +772,7 @@ This is a coroutine-safe drop-in replacement for Lua's "pcall"-function

    Return value:

    A boolean whether the function call succeeded and the returns - values of the function or the error object + values of the function or the error object @@ -807,30 +813,7 @@ This is a coroutine-safe drop-in replacement for Lua's "xpcall"-function

    Return value:

    A boolean whether the function call succeeded and the return - values of either the function or the error handler - - - -
    • - - - - -
    dtable ()
    -
    - - -Create a dynamic table which automatically creates subtables. - - - - - - - - -

    Return value:

    -Dynamic Table + values of either the function or the error handler @@ -944,8 +927,8 @@ Iterator Return the current runtime bytecode of the given data. The byte code - -will be stripped before it is returned. +will be stripped before it is returned. +

    Parameters

    @@ -976,11 +959,12 @@ String value containing the bytecode of the given data
    -Return a matching iterator for the given value. The iterator will return +Return a matching iterator for the given value. -one token per invocation, the tokens are separated by whitespace. If the -input value is a table, it is transformed into a string first. A nil value -will result in a valid interator which aborts with the first invocation. +The iterator will return one token per invocation, the tokens are separated by +whitespace. If the input value is a table, it is transformed into a string first. +A nil value will result in a valid interator which aborts with the first invocation. +

    Parameters

    @@ -1094,7 +1078,8 @@ Sorted table containing the keys Return a key, value iterator for the given table. -The table pairs are sorted by key. +The table pairs are sorted by key. +

    Parameters

    @@ -1149,9 +1134,11 @@ String containing the directory path Parse certain units from the given string and return the canonical integer +value or 0 if the unit is unknown. -value or 0 if the unit is unknown. Upper- or lower case is irrelevant. +Upper- or lower case is irrelevant. Recognized units are: + o "y" - one year (60*60*24*366) o "m" - one month (60*60*24*31) o "w" - one week (60*60*24*7) @@ -1163,7 +1150,8 @@ Recognized units are: o "gb" - one gigabyte (1024*1024*1024) o "kib" - one si kilobyte (1000) o "mib" - one si megabyte (1000*1000) - o "gib" - one si gigabyte (1000*1000*1000) + o "gib" - one si gigabyte (1000*1000*1000) +

    Parameters

    @@ -1304,8 +1292,8 @@ Value containing the restored data structure Recursively serialize given data to lua code, suitable for restoring - -with loadstring(). +with loadstring(). +

    Parameters

    @@ -1381,13 +1369,45 @@ String containing the JSON if called without write callback +
    shellquote (value)
    +
    + + +Safely quote value for use in shell commands. + + + +

    Parameters

    +
      + +
    • + value: String containing the value to quote +
      • + +
    + + + + + + +

    Return value:

    +Single-quote enclosed string with embedded quotes escaped + + + +
    + + + +
    spairs (t, f)
    Return a key, value iterator which returns the values sorted according to - -the provided callback function. +the provided callback function. +

    Parameters

    @@ -1423,11 +1443,13 @@ Function value containing the corresponding iterator Splits given string on a defined separator sequence and return a table +containing the resulting substrings. -containing the resulting substrings. The optional max parameter specifies -the number of bytes to process, regardless of the actual length of the given -string. The optional last parameter, regex, specifies whether the separator -sequence is interpreted as regular expression. +The optional max parameter specifies the number of bytes to process, +regardless of the actual length of the given string. The optional last +parameter, regex, specifies whether the separator sequence is +nterpreted as regular expression. +

    Parameters

    @@ -1471,10 +1493,11 @@ Table containing the resulting substrings
    -Strips unnescessary lua bytecode from given string. Information like line +Strips unnescessary lua bytecode from given string. -numbers and debugging numbers will be discarded. Original version by -Peter Cawley (http://lua-users.org/lists/lua-l/2008-02/msg01158.html) +Information like line numbers and debugging numbers will be discarded. +Original version by Peter Cawley (http://lua-users.org/lists/lua-l/2008-02/msg01158.html) +

    Parameters

    @@ -1538,9 +1561,11 @@ String with HTML tags stripped of Create a new or get an already existing thread local store associated with +the current active coroutine. -the current active coroutine. A thread local store is private a table object -whose values can't be accessed from outside of the running coroutine. +A thread local store is private a table object +whose values can't be accessed from outside of the running coroutine. + @@ -1636,7 +1661,8 @@ Table containin the ubus result Update values in given table with the values from the second given table. -Both table are - in fact - merged together. +Both table are - in fact - merged together. +

    Parameters

    @@ -1667,13 +1693,100 @@ Always nil +
    urldecode (str, decode_plus)
    +
    + + +Decode an URL-encoded string - optionally decoding the "+" sign to space. + + + +

    Parameters

    +
      + +
    • + str: Input string in x-www-urlencoded format +
      • + +
    • + decode_plus: Decode "+" signs to spaces if true (optional) +
      • + +
    + + + + + + +

    Return value:

    +The decoded string + + + +

    See also:

    + + +
    + + + + +
    urlencode (str)
    +
    + + +URL-encode given string. + + + +

    Parameters

    +
      + +
    • + str: String to encode +
      • + +
    + + + + + + +

    Return value:

    +String containing the encoded data + + + +

    See also:

    + + +
    + + + +
    vspairs (t)
    Return a key, value iterator for the given table. -The table pairs are sorted by value. +The table pairs are sorted by value. +

    Parameters

    diff --git a/documentation/api/modules/nixio.CHANGELOG.html b/documentation/api/modules/nixio.CHANGELOG.html index 48bedc80a..7d98747c2 100644 --- a/documentation/api/modules/nixio.CHANGELOG.html +++ b/documentation/api/modules/nixio.CHANGELOG.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.CryptoHash.html b/documentation/api/modules/nixio.CryptoHash.html index 6158a77b6..7d2f48b1e 100644 --- a/documentation/api/modules/nixio.CryptoHash.html +++ b/documentation/api/modules/nixio.CryptoHash.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.File.html b/documentation/api/modules/nixio.File.html index d9e67ea5b..7a7500a77 100644 --- a/documentation/api/modules/nixio.File.html +++ b/documentation/api/modules/nixio.File.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.README.html b/documentation/api/modules/nixio.README.html index 99e036b82..22dd79349 100644 --- a/documentation/api/modules/nixio.README.html +++ b/documentation/api/modules/nixio.README.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.Socket.html b/documentation/api/modules/nixio.Socket.html index 7d258fc19..185099125 100644 --- a/documentation/api/modules/nixio.Socket.html +++ b/documentation/api/modules/nixio.Socket.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.TLSContext.html b/documentation/api/modules/nixio.TLSContext.html index a91b1eec4..c84d31895 100644 --- a/documentation/api/modules/nixio.TLSContext.html +++ b/documentation/api/modules/nixio.TLSContext.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.TLSSocket.html b/documentation/api/modules/nixio.TLSSocket.html index 3d99a6482..5d6098a9f 100644 --- a/documentation/api/modules/nixio.TLSSocket.html +++ b/documentation/api/modules/nixio.TLSSocket.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.UnifiedIO.html b/documentation/api/modules/nixio.UnifiedIO.html index 700485dbe..6410ffb42 100644 --- a/documentation/api/modules/nixio.UnifiedIO.html +++ b/documentation/api/modules/nixio.UnifiedIO.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.bin.html b/documentation/api/modules/nixio.bin.html index fd8287912..48e6fcd8b 100644 --- a/documentation/api/modules/nixio.bin.html +++ b/documentation/api/modules/nixio.bin.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.bit.html b/documentation/api/modules/nixio.bit.html index b29c29d33..419736363 100644 --- a/documentation/api/modules/nixio.bit.html +++ b/documentation/api/modules/nixio.bit.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.crypto.html b/documentation/api/modules/nixio.crypto.html index 79a74584d..b91fe28c1 100644 --- a/documentation/api/modules/nixio.crypto.html +++ b/documentation/api/modules/nixio.crypto.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.fs.html b/documentation/api/modules/nixio.fs.html index 476e7fd31..c9d34591c 100644 --- a/documentation/api/modules/nixio.fs.html +++ b/documentation/api/modules/nixio.fs.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • diff --git a/documentation/api/modules/nixio.html b/documentation/api/modules/nixio.html index 8ee0f62dc..65294a658 100644 --- a/documentation/api/modules/nixio.html +++ b/documentation/api/modules/nixio.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
    • - -
  • - luci.http.protocol.mime + luci.http.mime
  • -- 2.11.0