Class JSArrayProxyMethodDefinitions

include/JSArrayProxy.hh:34–276

* @brief This struct is a bundle of methods used by the JSArrayProxy type * */

 *
 */
struct JSArrayProxyMethodDefinitions {
public:
  /**
   * @brief Deallocation method (.tp_dealloc), removes the reference to the underlying JSObject before freeing the JSArrayProxy
   *
   * @param self - The JSArrayProxy to be free'd
   */
  static void JSArrayProxy_dealloc(JSArrayProxy *self);

  /**
   * @brief Length method (.mp_length and .sq_length), returns the number of keys in the JSObject, used by the python len() method
   *
   * @param self - The JSArrayProxy
   * @return Py_ssize_t The length of the JSArrayProxy
   */
  static Py_ssize_t JSArrayProxy_length(JSArrayProxy *self);

  /**
   * @brief returns a value from the JSArrayProxy given a key, or dispatches to the given key method if such method is found
   *
   * @param self - The JSArrayProxy
   * @param key - The key for the value in the JSArrayProxy
   * @return PyObject* NULL on exception, the corresponding value otherwise
   */
  static PyObject *JSArrayProxy_get(JSArrayProxy *self, PyObject *key);


  /**
   * @brief Getter method (.mp_subscript), returns a value from the JSArrayProxy given a key which can be a slice, used by several built-in python methods as well as the [] and operator
   *
   * @param self - The JSArrayProxy
   * @param key - The key for the value in the JSArrayProxy
   * @return PyObject* NULL on exception, the corresponding value otherwise
   */
  static PyObject *JSArrayProxy_get_subscript(JSArrayProxy *self, PyObject *key);

  /**
   * @brief Assign method (.mp_ass_subscript), assigns a key-value pair if value is non-NULL, or deletes a key-value pair if value is NULL
   *
   * @param self - The JSArrayProxy
   * @param key - The key to be set or deleted
   * @param value If NULL, the key-value pair is deleted, if not NULL then a key-value pair is assigned
   * @return int -1 on exception, any other value otherwise
   */
  static int JSArrayProxy_assign_key(JSArrayProxy *self, PyObject *key, PyObject *value);

  /**
   * @brief Comparison method (.tp_richcompare), returns appropriate boolean given a comparison operator and other pyObject
   *
   * @param self - The JSArrayProxy
   * @param other - Any other PyObject
   * @param op - Which boolean operator is being performed (Py_EQ for equality, Py_NE for inequality, all other operators are not implemented)
   * @return PyObject* - True or false depending on result of comparison
   */
  static PyObject *JSArrayProxy_richcompare(JSArrayProxy *self, PyObject *other, int op);

  /**
   * @brief Return an iterator object to make JSArrayProxy iterable