Class PersistentDictionary<TValue>

Inheritance
object
PersistentDictionary<TValue>
Implements
Inherited Members
Namespace: Couchbase.DataStructures
Assembly: Couchbase.NetClient.dll
Syntax
public sealed class PersistentDictionary<TValue> : IPersistentDictionary<TValue>, IDictionary<string, TValue>, ICollection<KeyValuePair<string, TValue>>, IEnumerable<KeyValuePair<string, TValue>>, IEnumerable, IAsyncEnumerable<KeyValuePair<string, TValue>>
Type Parameters
Name Description
TValue

Properties

| Edit this page View Source

Count

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public int Count { get; }
Property Value
Type Description
int
| Edit this page View Source

CountAsync

Declaration
public Task<int> CountAsync { get; }
Property Value
Type Description
Task<int>
| Edit this page View Source

IsReadOnly

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
bool
| Edit this page View Source

this[string]

Declaration
[Obsolete("This method is blocking; please use the async equivalent instead.")]
public TValue this[string key] { get; set; }
Parameters
Type Name Description
string key
Property Value
Type Description
TValue
| Edit this page View Source

Keys

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public ICollection<string> Keys { get; }
Property Value
Type Description
ICollection<string>
| Edit this page View Source

KeysAsync

Declaration
public Task<ICollection<string>> KeysAsync { get; }
Property Value
Type Description
Task<ICollection<string>>
| Edit this page View Source

Values

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public ICollection<TValue> Values { get; }
Property Value
Type Description
ICollection<TValue>
| Edit this page View Source

ValuesAsync

Declaration
public Task<ICollection<TValue>> ValuesAsync { get; }
Property Value
Type Description
Task<ICollection<TValue>>

Methods

| Edit this page View Source

Add(KeyValuePair<string, TValue>)

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public void Add(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
KeyValuePair<string, TValue> item
| Edit this page View Source

Add(string, TValue)

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public void Add(string key, TValue value)
Parameters
Type Name Description
string key
TValue value
| Edit this page View Source

AddAsync(KeyValuePair<string, TValue>)

Declaration
public Task AddAsync(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
KeyValuePair<string, TValue> item
Returns
Type Description
Task
| Edit this page View Source

AddAsync(string, TValue)

Declaration
public Task AddAsync(string key, TValue value)
Parameters
Type Name Description
string key
TValue value
Returns
Type Description
Task
| Edit this page View Source

Clear()

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public void Clear()
| Edit this page View Source

ClearAsync()

Declaration
public Task ClearAsync()
Returns
Type Description
Task
| Edit this page View Source

Contains(KeyValuePair<string, TValue>)

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public bool Contains(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
KeyValuePair<string, TValue> item
Returns
Type Description
bool
| Edit this page View Source

ContainsAsync(KeyValuePair<string, TValue>)

Declaration
public Task<bool> ContainsAsync(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
KeyValuePair<string, TValue> item
Returns
Type Description
Task<bool>
| Edit this page View Source

ContainsKey(string)

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public bool ContainsKey(string key)
Parameters
Type Name Description
string key
Returns
Type Description
bool
| Edit this page View Source

ContainsKeyAsync(string)

Declaration
public Task<bool> ContainsKeyAsync(string key)
Parameters
Type Name Description
string key
Returns
Type Description
Task<bool>
| Edit this page View Source

CopyTo(KeyValuePair<string, TValue>[], int)

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public void CopyTo(KeyValuePair<string, TValue>[] array, int arrayIndex)
Parameters
Type Name Description
KeyValuePair<string, TValue>[] array
int arrayIndex
| Edit this page View Source

GetAsync(string)

Declaration
public Task<TValue> GetAsync(string key)
Parameters
Type Name Description
string key
Returns
Type Description
Task<TValue>
| Edit this page View Source

GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

Declaration
public IAsyncEnumerator<KeyValuePair<string, TValue>> GetAsyncEnumerator(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

A CancellationToken that may be used to cancel the asynchronous iteration.
Returns
Type Description
IAsyncEnumerator<KeyValuePair<string, TValue>>

An enumerator that can be used to iterate asynchronously through the collection.
| Edit this page View Source

GetEnumerator()

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public IEnumerator<KeyValuePair<string, TValue>> GetEnumerator()
Returns
Type Description
IEnumerator<KeyValuePair<string, TValue>>
| Edit this page View Source

Remove(KeyValuePair<string, TValue>)

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public bool Remove(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
KeyValuePair<string, TValue> item
Returns
Type Description
bool
| Edit this page View Source

Remove(string)

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public bool Remove(string key)
Parameters
Type Name Description
string key
Returns
Type Description
bool
| Edit this page View Source

RemoveAsync(KeyValuePair<string, TValue>)

Declaration
public Task<bool> RemoveAsync(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
KeyValuePair<string, TValue> item
Returns
Type Description
Task<bool>
| Edit this page View Source

RemoveAsync(string)

Declaration
public Task<bool> RemoveAsync(string key)
Parameters
Type Name Description
string key
Returns
Type Description
Task<bool>
| Edit this page View Source

SetAsync(string, TValue)

Declaration
public Task SetAsync(string key, TValue value)
Parameters
Type Name Description
string key
TValue value
Returns
Type Description
Task
| Edit this page View Source

TryGetValue(string, out TValue)

Declaration
[Obsolete("This method is blocking; please use the async version instead.")]
public bool TryGetValue(string key, out TValue value)
Parameters
Type Name Description
string key
TValue value
Returns
Type Description
bool

Implements