pluginbase.Dependencies.ICacheProvider Interface Reference

Per-system cache provider. Specific to the plugin More...

Public Member Functions
bool	Exists (string slug)
	Check if the cache item with the specific slug exists More...
Stream	OpenRead (string slug)
	Open a cache item for reading. Will throw exception if not found Will decompress automatically if compression was enabled More...
Stream	OpenWrite (string slug, bool truncate=true, bool compress=false)
	Open a cache item for writing Will overwrite any existing data More...
void	Write< T > (string slug, T obj)
	Write an object of type T to a cache object More...
T	Read< T > (string slug)
	Read the specified slug. Will return default(T) if it doesn't exist More...
T	Read< T > (string slug, T def)
	Read the specified slug. Will return def/// More...
void	Delete (string slug)
	Delete the cache item with the slug More...

Detailed Description

Per-system cache provider. Specific to the plugin

Attribute: Injectable

Member Function Documentation

Delete()

void pluginbase.Dependencies.ICacheProvider.Delete

(

string

slug

)

Delete the cache item with the slug

Parameters

slug

Slug.

Exists()

bool pluginbase.Dependencies.ICacheProvider.Exists

(

string

slug

)

Check if the cache item with the specific slug exists

Parameters

slug

Slug.

OpenRead()

Stream pluginbase.Dependencies.ICacheProvider.OpenRead

(

string

slug

)

Open a cache item for reading. Will throw exception if not found Will decompress automatically if compression was enabled

Returns

The stream.

Parameters

slug

Slug.

OpenWrite()

Stream pluginbase.Dependencies.ICacheProvider.OpenWrite	(	string	slug,
		bool	truncate = true,
		bool	compress = false
	)

Open a cache item for writing Will overwrite any existing data

Returns

The stream.

Parameters

slug	Slug.
truncate	Truncate any existing file
compress	If true, will use gzip compression. Truncate must also be true.

Read< T >() [1/2]

T pluginbase.Dependencies.ICacheProvider.Read< T >

(

string

slug

)

Read the specified slug. Will return default(T) if it doesn't exist

Parameters

slug

Slug.

Template Parameters

T	The type of the cache object.

Read< T >() [2/2]

T pluginbase.Dependencies.ICacheProvider.Read< T >	(	string	slug,
		T	def
	)

Read the specified slug. Will return def///

Attribute: ault

if it doesn't exist.

Parameters

slug	Slug.
def	Def.

Template Parameters

T	The type of the cache.

Write< T >()

void pluginbase.Dependencies.ICacheProvider.Write< T >	(	string	slug,
		T	obj
	)

Write an object of type T to a cache object

Parameters

slug	Slug.
obj	Object.

Template Parameters

T	Object type

---

The documentation for this interface was generated from the following file:

• pluginbase/Dependencies/ICacheProvider.cs