Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoRssItem

Description

A list of VuoRssItem elements.

Classes

struct  VuoList_VuoRssItem_struct
 A list of VuoRssItem elements. More...
 

Typedefs

typedef const struct VuoList_VuoRssItem_structVuoList_VuoRssItem
 A list of VuoRssItem elements. More...
 

Functions

VuoList_VuoRssItem VuoListCreate_VuoRssItem (void)
 Creates a new list of VuoRssItem elements. More...
 
VuoList_VuoRssItem VuoListCreateWithCount_VuoRssItem (const unsigned long count, const VuoRssItem value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoRssItem VuoListCopy_VuoRssItem (const VuoList_VuoRssItem list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoRssItem VuoListGetValue_VuoRssItem (const VuoList_VuoRssItem list, const unsigned long index)
 Returns the VuoRssItem at index. More...
 
VuoRssItemVuoListGetData_VuoRssItem (const VuoList_VuoRssItem list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoRssItem (const VuoList_VuoRssItem list, bool(^function)(const VuoRssItem value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoRssItem (const VuoList_VuoRssItem list, const VuoRssItem value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoRssItem at index. More...
 
void VuoListInsertValue_VuoRssItem (const VuoList_VuoRssItem list, const VuoRssItem value, const unsigned long index)
 Inserts the VuoRssItem immediately before index. More...
 
void VuoListPrependValue_VuoRssItem (VuoList_VuoRssItem list, const VuoRssItem value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoRssItem (VuoList_VuoRssItem list, const VuoRssItem value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoRssItem (VuoList_VuoRssItem list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoRssItem (VuoList_VuoRssItem list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoRssItem (VuoList_VuoRssItem list)
 Reverses the order of the items in list. More...
 
VuoList_VuoRssItem VuoListSubset_VuoRssItem (VuoList_VuoRssItem list, const signed long startIndex, const unsigned long itemCount)
 Returns a new list containing items from the original list in the range specified by startIndex and itemCount. More...
 
void VuoListRemoveFirstValue_VuoRssItem (VuoList_VuoRssItem list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoRssItem (VuoList_VuoRssItem list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoRssItem (VuoList_VuoRssItem list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoRssItem (VuoList_VuoRssItem list, const unsigned long index)
 Removes the VuoRssItem at index. More...
 
unsigned long VuoListGetCount_VuoRssItem (const VuoList_VuoRssItem list)
 Returns the number of elements in list. More...
 
VuoList_VuoRssItem VuoList_VuoRssItem_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoRssItem_getJson (const VuoList_VuoRssItem value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoRssItem_getSummary (const VuoList_VuoRssItem value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoRssItem VuoList_VuoRssItem_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoRssItem_getString (const VuoList_VuoRssItem value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoRssItem_struct

struct VuoList_VuoRssItem_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoRssItem

A list of VuoRssItem elements.

Function Documentation

◆ VuoList_VuoRssItem_getJson()

struct json_object* VuoList_VuoRssItem_getJson ( const VuoList_VuoRssItem  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoRssItem.cc.

◆ VuoList_VuoRssItem_getString()

char* VuoList_VuoRssItem_getString ( const VuoList_VuoRssItem  value)

Automatically generated function.

◆ VuoList_VuoRssItem_getSummary()

char* VuoList_VuoRssItem_getSummary ( const VuoList_VuoRssItem  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoRssItem.cc.

◆ VuoList_VuoRssItem_makeFromJson()

VuoList_VuoRssItem VuoList_VuoRssItem_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]

Definition at line 63 of file VuoList_VuoRssItem.cc.

◆ VuoList_VuoRssItem_makeFromString()

VuoList_VuoRssItem VuoList_VuoRssItem_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoRssItem()

void VuoListAppendValue_VuoRssItem ( VuoList_VuoRssItem  list,
const VuoRssItem  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoRssItem.cc.

◆ VuoListCopy_VuoRssItem()

VuoList_VuoRssItem VuoListCopy_VuoRssItem ( const VuoList_VuoRssItem  list)

Makes a shallow copy of list — its items are retained (not copied) by the new list.

Definition at line 174 of file VuoList_VuoRssItem.cc.

◆ VuoListCreate_VuoRssItem()

VuoList_VuoRssItem VuoListCreate_VuoRssItem ( void  )

Creates a new list of VuoRssItem elements.

Definition at line 154 of file VuoList_VuoRssItem.cc.

◆ VuoListCreateWithCount_VuoRssItem()

VuoList_VuoRssItem VuoListCreateWithCount_VuoRssItem ( const unsigned long  count,
const VuoRssItem  value 
)

Creates a new list of count instances of value.

Use this in conjunction with VuoListGetData_VuoRssItem to quickly initialize a large list.

Definition at line 161 of file VuoList_VuoRssItem.cc.

◆ VuoListExchangeValues_VuoRssItem()

void VuoListExchangeValues_VuoRssItem ( VuoList_VuoRssItem  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

Definition at line 318 of file VuoList_VuoRssItem.cc.

◆ VuoListForeach_VuoRssItem()

void VuoListForeach_VuoRssItem ( const VuoList_VuoRssItem  list,
bool(^)(const VuoRssItem value)  function 
)

Applies function to each of list's items, serially in order of index.

If function returns false, visiting will stop immediately (possibly before all items have been visited).

Changed in Vuo 2.0.0:
New.

Definition at line 229 of file VuoList_VuoRssItem.cc.

◆ VuoListGetCount_VuoRssItem()

unsigned long VuoListGetCount_VuoRssItem ( const VuoList_VuoRssItem  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoRssItem.cc.

◆ VuoListGetData_VuoRssItem()

VuoRssItem* VuoListGetData_VuoRssItem ( const VuoList_VuoRssItem  list)

Returns a pointer to a C array containing the list items.

Use this if you need a fast way to get or change multiple list items.

You can modify values in the list by changing them in this array. Just don't attempt to access beyond the list size.

The pointer becomes invalid if you modify the list size using other functions (e.g., Insert, Prepend, Append, Cut, Remove); if you use those functions, just get a new pointer by calling this function again.

If the list has no items, returns NULL.

The pointer remains owned by the list; don't free it.

Definition at line 219 of file VuoList_VuoRssItem.cc.

◆ VuoListGetValue_VuoRssItem()

VuoRssItem VuoListGetValue_VuoRssItem ( const VuoList_VuoRssItem  list,
const unsigned long  index 
)

Returns the VuoRssItem at index.

Index values start at 1. If the list has no items, returns a default value. Attempting to access an out-of-bounds index returns the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

If iterating over an entire list, consider using VuoListGetData_VuoRssItem or VuoListForeach_VuoRssItem.

Definition at line 203 of file VuoList_VuoRssItem.cc.

◆ VuoListInsertValue_VuoRssItem()

void VuoListInsertValue_VuoRssItem ( const VuoList_VuoRssItem  list,
const VuoRssItem  value,
const unsigned long  index 
)

Inserts the VuoRssItem immediately before index.

Index values start at 1. Inserting at index 0 prepends the value to the list. Inserting at an index beyond the last value in the list appends the value to the list.

Definition at line 276 of file VuoList_VuoRssItem.cc.

◆ VuoListPrependValue_VuoRssItem()

void VuoListPrependValue_VuoRssItem ( VuoList_VuoRssItem  list,
const VuoRssItem  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoRssItem.cc.

◆ VuoListRemoveAll_VuoRssItem()

void VuoListRemoveAll_VuoRssItem ( VuoList_VuoRssItem  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoRssItem.cc.

◆ VuoListRemoveFirstValue_VuoRssItem()

void VuoListRemoveFirstValue_VuoRssItem ( VuoList_VuoRssItem  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoRssItem.cc.

◆ VuoListRemoveLastValue_VuoRssItem()

void VuoListRemoveLastValue_VuoRssItem ( VuoList_VuoRssItem  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoRssItem.cc.

◆ VuoListRemoveValue_VuoRssItem()

void VuoListRemoveValue_VuoRssItem ( VuoList_VuoRssItem  list,
const unsigned long  index 
)

Removes the VuoRssItem at index.

Index values start at 1. Attempting to remove index 0 or an index beyond the last value in the list has no effect.

Definition at line 536 of file VuoList_VuoRssItem.cc.

◆ VuoListReverse_VuoRssItem()

void VuoListReverse_VuoRssItem ( VuoList_VuoRssItem  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoRssItem.cc.

◆ VuoListSetValue_VuoRssItem()

void VuoListSetValue_VuoRssItem ( const VuoList_VuoRssItem  list,
const VuoRssItem  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoRssItem at index.

Index values start at 1.

If expandListIfNeeded is false: If the list has no items, nothing is changed. Attempting to change an out-of-bounds index changes the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

If expandListIfNeeded is true: If the list has less than index elements, it is expanded to accommodate the specified index. If index is 0, the list is resized to contain 1 item set to value.

Definition at line 241 of file VuoList_VuoRssItem.cc.

◆ VuoListShuffle_VuoRssItem()

void VuoListShuffle_VuoRssItem ( VuoList_VuoRssItem  list,
const double  chaos 
)

Generates a random permutation of list.

chaos ranges from 0 to 1. When chaos is 1, a full Fisher–Yates shuffle is performed. When less than 1, fewer iterations are performed.

Definition at line 401 of file VuoList_VuoRssItem.cc.

◆ VuoListSubset_VuoRssItem()

VuoList_VuoRssItem VuoListSubset_VuoRssItem ( VuoList_VuoRssItem  list,
const signed long  startIndex,
const unsigned long  itemCount 
)

Returns a new list containing items from the original list in the range specified by startIndex and itemCount.

Items in the new list are retained (not copied) from the original list.

Definition at line 431 of file VuoList_VuoRssItem.cc.