koi_net.components.cache

Classes

Cache(config, root_dir)

Default storage component for a KOI node.
class koi_net.components.cache.Cache(config, root_dir)[source]

Bases: object

Default storage component for a KOI node.

Stores bundles as JSON documents within a cache directory, where the filename is the base-64 encoding of an RID.

Parameters:
config: BaseNodeConfig
delete(rid)[source]

Deletes cache bundle.

Return type:

None

Parameters:

rid (RID)

property directory_path
drop()[source]

Deletes all cache bundles.

Return type:

None

exists(rid)[source]
Return type:

bool

Parameters:

rid (RID)

file_path_to(rid)[source]
Return type:

str

Parameters:

rid (RID)

list_rids(rid_types=None)[source]

Returns a list of the RIDs of all bundles in cache.

Return type:

list[RID]

Parameters:

rid_types (list[RIDType] | None)

read(rid)[source]

Attempts to read an RIDed Bundle from cache.

Return type:

Bundle | None

Parameters:

rid (RID)

root_dir: Path
write(bundle)[source]

Writes bundle to cache, returns a Bundle.

Return type:

Bundle

Parameters:

bundle (Bundle)