IImageMetadataCache Interface Reference

A cache with image metadata. More...

Inherits IDisposable.

Public Member Functions
Task	RemoveAsync (CancellationToken cancellationToken)
	Asynchronously removes cache data. More...
Task< Size?>	GetSizeAsync (CancellationToken cancellationToken)
	Asynchronously gets the image dimensions. More...
Task	SetSizeAsync (Size size, CancellationToken cancellationToken)
	Asynchronously sets the cached value of image dimensions. More...
Task< ulong?>	GetHashAsync (CancellationToken cancellationToken)
	Asynchronously gets the image hash. More...
Task	SetHashAsync (ulong hash, CancellationToken cancellationToken)
	Asynchronously sets the cached value of image hash. More...

Properties
IFile	File [get]
	Get the image file for this cache. More...

Detailed Description

A cache with image metadata.

Member Function Documentation

GetHashAsync()

Task<ulong?> GetHashAsync

(

CancellationToken

cancellationToken

)

Asynchronously gets the image hash.

May be null if hash is not yet in cache.

Parameters

cancellationToken

A cancellation token.

Returns

An image hash.

GetSizeAsync()

Task<Size?> GetSizeAsync

(

CancellationToken

cancellationToken

)

Asynchronously gets the image dimensions.

May be null if size is not yet in cache.

Parameters

cancellationToken

A cancellation token.

Returns

An image dimensions.

RemoveAsync()

Task RemoveAsync

(

CancellationToken

cancellationToken

)

Asynchronously removes cache data.

Parameters

cancellationToken

A cancellation token.

SetHashAsync()

Task SetHashAsync	(	ulong	hash,
		CancellationToken	cancellationToken
	)

Asynchronously sets the cached value of image hash.

Parameters

hash	An image hash.
cancellationToken	A cancellation token.

SetSizeAsync()

Task SetSizeAsync	(	Size	size,
		CancellationToken	cancellationToken
	)

Asynchronously sets the cached value of image dimensions.

Parameters

size	An image size.
cancellationToken	A cancellation token.

Property Documentation

File

IFile File

get

Get the image file for this cache.

---

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

• IImageMetadataCache.cs