Home Explore Blog CI



neovim

1st chunk of `runtime/doc/pi_msgpack.txt`
a8b95903675580e348177188ce0c02d9c8912249bc8e68230000000100000d27
*pi_msgpack.txt*   msgpack utilities

Author:  Nikolay Pavlov <kp-pav@yandex.ru>
Copyright: (c) 2015 by Nikolay Pavlov

The Apache license applies to the files in this package, including
runtime/autoload/msgpack.vim, runtime/doc/pi_msgpack.txt and
test/functional/plugin/msgpack_spec.lua.  Like anything else that's free,
msgpack.vim and its associated files are provided as is and comes with no
warranty of any kind, either expressed or implied.  No guarantees of
merchantability.  No guarantees of suitability for any purpose.  By using this
plugin, you agree that in no event will the copyright holder be liable for any
damages resulting from the use of this software. Use at your own risk!

==============================================================================
1. Contents				*msgpack.vim-contents*

	1. Contents..............................: |msgpack.vim-contents|
	2. Msgpack.vim introduction..............: |msgpack.vim-intro|
	3. Msgpack.vim manual....................: |msgpack.vim-manual|
	   Function arguments....................: |msgpack.vim-arguments|
	   msgpack#is_int function...............: |msgpack#is_int()|
	   msgpack#is_uint function..............: |msgpack#is_uint()|
	   msgpack#strftime function.............: |msgpack#strftime()|
	   msgpack#strptime function.............: |msgpack#strptime()|
	   msgpack#int_dict_to_str function......: |msgpack#int_dict_to_str()|
	   msgpack#special_type function.........: |msgpack#special_type()|
	   msgpack#type function.................: |msgpack#type()|
	   msgpack#deepcopy function.............: |msgpack#deepcopy()|
	   msgpack#string function...............: |msgpack#string()|
	   msgpack#eval function.................: |msgpack#eval()|
	   msgpack#equal function................: |msgpack#equal()|


==============================================================================
2. Msgpack.vim introduction			*msgpack.vim-intro*

This plugin contains utility functions to be used in conjunction with
|msgpackdump()| and |msgpackparse()| functions.

==============================================================================
3. Msgpack.vim manual				*msgpack.vim-manual*

FUNCTION ARGUMENTS				*msgpack.vim-arguments*

Disambiguation of arguments described below.  Note: if e.g. function is listed
as accepting |{msgpack-integer}| (or anything else) it means that function
does not check whether argument matches its description.

*{msgpack-value}*	Either |msgpack-special-dict| or a regular value, but
			not function reference.
*{msgpack-integer}*	Any value for which |msgpack#type()| will return
			"integer".
*{msgpack-special-int}*	|msgpack-special-dict| representing integer.

msgpack#is_int({msgpack-value})				*msgpack#is_int()*
	Returns 1 if given {msgpack-value} is integer value, 0 otherwise.

msgpack#is_uint({msgpack-value})			*msgpack#is_uint()*
	Returns 1 if given {msgpack-value} is integer value greater or equal
	to zero, 0 otherwise.

							*msgpack#strftime*
msgpack#strftime({format}, {msgpack-integer})		*msgpack#strftime()*
	Same as |strftime()|, but second argument may be
	|msgpack-special-dict|.  Requires |Python| to really work with
	|msgpack-special-dict|s.

							*msgpack#strptime*
msgpack#strptime({format}, {time})			*msgpack#strptime()*
	Reverse of |msgpack#strftime()|: for any time and format
	|msgpack#equal|( |msgpack#strptime|(format,

Title: pi_msgpack.txt: Msgpack Utilities
Summary
This document describes the msgpack.vim plugin, which provides utility functions for use with msgpackdump() and msgpackparse() in Vim. It covers topics such as function arguments, integer checks, date/time formatting and parsing, and special dictionary handling.