VuoFileType

Description

The type of data in a file.

Enumerations
enum	VuoFileType {   VuoFileType_AnyFile , VuoFileType_Audio , VuoFileType_Image , VuoFileType_Mesh ,   VuoFileType_Movie , VuoFileType_Scene , VuoFileType_Folder , VuoFileType_Feed ,   VuoFileType_App , VuoFileType_Data , VuoFileType_JSON , VuoFileType_Table ,   VuoFileType_XML }
	The type of data in a file. More...

Functions
VuoFileType	VuoFileType_makeFromJson (json_object *js)
	Decodes the JSON object js to create a new value. More...
json_object *	VuoFileType_getJson (const VuoFileType value)
	Encodes value as a JSON object. More...
char *	VuoFileType_getSummary (const VuoFileType value)
	Returns a compact string representation of value. More...
bool	VuoFileType_isFileOfType (const VuoText path, VuoFileType fileType)
	Returns true if path is of type fileType, based on the file extension. More...
VuoList_VuoFileType	VuoFileType_getAllowedValues (void)
	Returns a list of values that instances of this type can have. More...
struct json_object *	VuoFileType_getExtensions (VuoFileType fileType)
	Returns a JSON array of file extensions for the specified fileType. More...
VuoFileType	VuoFileType_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoFileType_getString (const VuoFileType value)
	Automatically generated function. More...
void	VuoFileType_retain (VuoFileType value)
	Automatically generated function. More...
void	VuoFileType_release (VuoFileType value)
	Automatically generated function. More...

Enumeration Type Documentation

VuoFileType

enum VuoFileType

The type of data in a file.

Definition at line 34 of file VuoFileType.h.

Function Documentation

VuoFileType_getAllowedValues()

VuoList_VuoFileType VuoFileType_getAllowedValues

(

void

)

Returns a list of values that instances of this type can have.

Definition at line 131 of file VuoFileType.c.

VuoFileType_getExtensions()

struct json_object* VuoFileType_getExtensions

(

VuoFileType

fileType

)

Returns a JSON array of file extensions for the specified fileType.

Do not modify or free the returned object.

Definition at line 231 of file VuoFileType.c.

VuoFileType_getJson()

struct json_object * VuoFileType_getJson

(

const VuoFileType

value

)

Encodes value as a JSON object.

Definition at line 96 of file VuoFileType.c.

VuoFileType_getString()

char* VuoFileType_getString

(

const VuoFileType

value

)

Automatically generated function.

VuoFileType_getSummary()

char * VuoFileType_getSummary

(

const VuoFileType

value

)

Returns a compact string representation of value.

Definition at line 155 of file VuoFileType.c.

VuoFileType_isFileOfType()

bool VuoFileType_isFileOfType	(	const VuoText	path,
		VuoFileType	fileType
	)

Returns true if path is of type fileType, based on the file extension.

This function does not check whether path exists, or differentiate between files and folders.

Definition at line 202 of file VuoFileType.c.

VuoFileType_makeFromJson()

VuoFileType VuoFileType_makeFromJson

(

json_object *

js

)

Decodes the JSON object js to create a new value.

Definition at line 56 of file VuoFileType.c.

VuoFileType_makeFromString()

VuoFileType VuoFileType_makeFromString

(

const char *

str

)

Automatically generated function.

VuoFileType_release()

void VuoFileType_release

(

VuoFileType

value

)

Automatically generated function.

VuoFileType_retain()

void VuoFileType_retain

(

VuoFileType

value

)

Automatically generated function.