Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class PersistentDictionary<TValue>

Inheritance
object
PersistentDictionary<TValue>
Implements
IPersistentDictionary<TValue>
IDictionary<string, TValue>
ICollection<KeyValuePair<string, TValue>>
IEnumerable<KeyValuePair<string, TValue>>
IEnumerable
IAsyncEnumerable<KeyValuePair<string, TValue>>
Inherited Members
object.GetType()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
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

View Source

Count

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

CountAsync

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

IsReadOnly

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
bool
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
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>
View Source

KeysAsync

Declaration
public Task<ICollection<string>> KeysAsync { get; }
Property Value
Type Description
Task<ICollection<string>>
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>
View Source

ValuesAsync

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

Methods

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
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
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
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
View Source

Clear()

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

ClearAsync()

Declaration
public Task ClearAsync()
Returns
Type Description
Task
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
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>
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
View Source

ContainsKeyAsync(string)

Declaration
public Task<bool> ContainsKeyAsync(string key)
Parameters
Type Name Description
string key
Returns
Type Description
Task<bool>
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
View Source

GetAsync(string)

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

GetAsyncEnumerator(CancellationToken)

Declaration
public IAsyncEnumerator<KeyValuePair<string, TValue>> GetAsyncEnumerator(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
IAsyncEnumerator<KeyValuePair<string, TValue>>
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>>
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
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
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>
View Source

RemoveAsync(string)

Declaration
public Task<bool> RemoveAsync(string key)
Parameters
Type Name Description
string key
Returns
Type Description
Task<bool>
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
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

IPersistentDictionary<TValue>
IDictionary<TKey, TValue>
ICollection<T>
IEnumerable<T>
IEnumerable
IAsyncEnumerable<T>
  • View Source
In this article
Back to top Copyright © 2020 Couchbase, Inc. All rights reserved.