FileBackedDictionaryTKey, TValue Class

Represents a lookup table of key/value pairs backed by a file, with very little memory overhead.

Inheritance Hierarchy

SystemObject
GSF.CollectionsFileBackedDictionaryTKey, TValue

Namespace: GSF.Collections
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

C++

JavaScript

Copy

public sealed class FileBackedDictionary<TKey, TValue> : IDictionary<TKey, TValue>, 
	ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, 
	IEnumerable, IDisposable

Public NotInheritable Class FileBackedDictionary(Of TKey, TValue)
	Implements IDictionary(Of TKey, TValue), ICollection(Of KeyValuePair(Of TKey, TValue)), 
	IEnumerable(Of KeyValuePair(Of TKey, TValue)), IEnumerable, 
	IDisposable

generic<typename TKey, typename TValue>
public ref class FileBackedDictionary sealed : IDictionary<TKey, TValue>, 
	ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, 
	IEnumerable, IDisposable

[<SealedAttribute>]
type FileBackedDictionary<'TKey, 'TValue> = 
    class
        interface IDictionary<'TKey, 'TValue>
        interface ICollection<KeyValuePair<'TKey, 'TValue>>
        interface IEnumerable<KeyValuePair<'TKey, 'TValue>>
        interface IEnumerable
        interface IDisposable
    end

JavaScript does not support generic types or methods.

View Source

Type Parameters

TKey: The type of the keys in the lookup table.
TValue: The type of the values in the lookup table.

The FileBackedDictionaryTKey, TValue type exposes the following members.

Constructors

	Name	Description
	FileBackedDictionaryTKey, TValue	Creates a new instance of the FileBackedDictionaryTKey, TValue class.
	FileBackedDictionaryTKey, TValue(IDictionaryTKey, TValue)	Creates a new instance of the FileBackedDictionaryTKey, TValue class.
	FileBackedDictionaryTKey, TValue(IEqualityComparerTKey)	Creates a new instance of the FileBackedDictionaryTKey, TValue class.
	FileBackedDictionaryTKey, TValue(String)	Creates a new instance of the FileBackedDictionaryTKey, TValue class.
	FileBackedDictionaryTKey, TValue(IDictionaryTKey, TValue, IEqualityComparerTKey)	Creates a new instance of the FileBackedDictionaryTKey, TValue class.
	FileBackedDictionaryTKey, TValue(String, IDictionaryTKey, TValue)	Creates a new instance of the FileBackedDictionaryTKey, TValue class.
	FileBackedDictionaryTKey, TValue(String, IEqualityComparerTKey)	Creates a new instance of the FileBackedDictionaryTKey, TValue class.
	FileBackedDictionaryTKey, TValue(String, IDictionaryTKey, TValue, IEqualityComparerTKey)	Creates a new instance of the FileBackedDictionaryTKey, TValue class.

Top

Properties

	Name	Description
	CacheSize	Gets or sets the size of the cache used to store data from the file in memory.
	Count	Gets the number of elements contained in the FileBackedDictionaryTKey, TValue.
	DefaultSignature	Gets the default signature used by the FileBackedDictionaryTKey, TValue if no user-defined signature is supplied.
	FilePath	Gets or sets the path to the file backing this dictionary.
	FragmentationCount	Gets the number of operations that fragment the lookup table that have occurred since the last time the lookup table was compacted.
	IsReadOnly	Gets a value indicating whether the FileBackedDictionaryTKey, TValue is read-only.
	Item	Gets or sets the element with the specified key.
	Keys	Gets an FileBackedDictionaryTKey, TValue containing the keys of the FileBackedDictionaryTKey, TValue.
	Signature	Gets or sets the signature of the file backing the lookup table.
	Values	Gets an FileBackedDictionaryTKey, TValue containing the values in the FileBackedDictionaryTKey, TValue.

Top

Methods

	Name	Description
	Add(KeyValuePairTKey, TValue)	Adds an item to the FileBackedDictionaryTKey, TValue.
	Add(TKey, TValue)	Adds an element with the provided key and value to the FileBackedDictionaryTKey, TValue.
	Clear	Removes all items from the FileBackedDictionaryTKey, TValue.
	Close	Closes the file backing this dictionary.
	Compact	Defragments the item section of the dictionary, which gets fragmented after removing keys or updating values.
	Contains	Determines whether the FileBackedDictionaryTKey, TValue contains a specific value.
	ContainsKey	Determines whether the FileBackedDictionaryTKey, TValue contains an element with the specified key.
	CopyTo	Copies the elements of the FileBackedDictionaryTKey, TValue to an Array, starting at a particular Array index.
	Dispose	Releases all the resources used by the FileBackedDictionaryTKey, TValue object.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetKeys	Gets an enumerable used to iterate only the keys in the dictionary.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetValues	Gets an enumerable used to iterate only the values in the dictionary.
	Open	Opens the file backing this dictionary.
	OpenRead	Opens the file backing this hash set in read-only mode.
	Remove(TKey)	Removes the element with the specified key from the FileBackedDictionaryTKey, TValue.
	Remove(KeyValuePairTKey, TValue)	Removes the first occurrence of a specific object from the FileBackedDictionaryTKey, TValue.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryGetValue	Gets the value associated with the specified key.

Top

Extension Methods

	Name	Description
	AllParallelKeyValuePairTKey, TValue	Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel. (Defined by CollectionExtensions)
	DistinctByKeyValuePairTKey, TValue, TKey	Returns only the elements whose keys are distinct. (Defined by CollectionExtensions)
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	MajorityKeyValuePairTKey, TValue	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityKeyValuePairTKey, TValue	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByKeyValuePairTKey, TValue, TKey	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByKeyValuePairTKey, TValue, TKey	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MaxKeyValuePairTKey, TValue	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxKeyValuePairTKey, TValue	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxByKeyValuePairTKey, TValue, TKey	Selects the largest item from the enumeration. (Defined by CollectionExtensions)
	MedianKeyValuePairTKey, TValue	Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MiddleKeyValuePairTKey, TValue	Gets the middle item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MinKeyValuePairTKey, TValue	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinKeyValuePairTKey, TValue	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinByKeyValuePairTKey, TValue, TKey	Selects the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinorityKeyValuePairTKey, TValue	Returns the minority value in the collection, or default type value if no item represents the minority. (Defined by CollectionExtensions)
	MinorityKeyValuePairTKey, TValue	Returns the minority value in the collection, or defaultValue if no item represents the minority. (Defined by CollectionExtensions)
	MinorityByKeyValuePairTKey, TValue, TKey	Returns the minority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MinorityByKeyValuePairTKey, TValue, TKey	Returns the minority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	StandardDeviationKeyValuePairTKey, TValue	Computes the standard deviation over a sequence of Double values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationKeyValuePairTKey, TValue	Computes the standard deviation over a sequence of Decimal values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationKeyValuePairTKey, TValue	Computes the standard deviation over a sequence of Single values. (Defined by NumericalAnalysisExtensions)
	ToDelimitedStringKeyValuePairTKey, TValue	Converts an enumeration to a string, using the default delimiter ("\|") that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringKeyValuePairTKey, TValue	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringKeyValuePairTKey, TValue	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToPagedListKeyValuePairTKey, TValue	Gets a PagedListT to paginate source enumeration for a given page and specified pageSize. (Defined by CollectionExtensions)

Top

Reference

GSF.Collections Namespace