Camel.UIDCache

Fields

Name	Type	Access	Description
expired	int	r/w
fd	int	r/w
filename	str	r/w
level	int	r/w
size	int	r/w
uids	{object: object}	r/w

Methods

class	free_uids (uids)
	destroy ()
	get_new_uids (uids)
	save ()
	save_uid (uid)

Details

class Camel.UIDCache

classmethod free_uids(uids)

Parameters:

uids ([str]) – an array returned from Camel.UIDCache.get_new_uids()

Frees the array of UIDs.

destroy()

Destroys self and frees its data.

get_new_uids(uids)

Parameters:

uids ([str]) – an array of UIDs

Returns:

an array of new UIDs, which must be freed with Camel.UIDCache.free_uids().

Return type:

[str]

Returns an array of UIDs from uids that are not in self, and removes UIDs from self that aren’t in uids.

save()

Returns:

success or failure

Return type:

bool

Attempts to save self back to disk.

save_uid(uid)

Parameters:

uid (str) – a uid to save

Marks a uid for saving.