Struct Key<TEntity, TKey>

This is used to create strongly-typed ids.

Implements
IKey<TEntity, TKey>
IEquatable<Key<TEntity, TKey>>
Namespace: Venflow
Assembly: Venflow.Keys.dll
Syntax
public struct Key<TEntity, TKey> : IKey<TEntity, TKey>, IKey, IEquatable<Key<TEntity, TKey>> where TKey : struct, IEquatable<TKey>
Type Parameters
Name Description
TEntity

They type of entity the key sits in.
TKey

The type of the key.
Remarks

You can also create more specific implementations of this type, by creating a struct implementing IKey<TEntity, TKey>.

Constructors

| Improve this Doc View Source

Key(TKey)

Instantiates a new Key<TEntity, TKey> instance withe the provided value.

Declaration
public Key(TKey value)
Parameters
Type Name Description
TKey value

The value which should represent the new Key<TEntity, TKey> instance.

Methods

| Improve this Doc View Source

Equals(Nullable<Object>)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
Nullable<Object> obj
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Key<TEntity, TKey>)

Declaration
public bool Equals(Key<TEntity, TKey> other)
Parameters
Type Name Description
Key<TEntity, TKey> other
Returns
Type Description
Boolean
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
| Improve this Doc View Source

ToString()

Declaration
public override string? ToString()
Returns
Type Description
Nullable<String>

Operators

| Improve this Doc View Source

Equality(Key<TEntity, TKey>, Key<TEntity, TKey>)

Declaration
public static bool operator ==(in Key<TEntity, TKey> a, in Key<TEntity, TKey> b)
Parameters
Type Name Description
Key<TEntity, TKey> a
Key<TEntity, TKey> b
Returns
Type Description
Boolean
| Improve this Doc View Source

Implicit(TKey to Key<TEntity, TKey>)

Declaration
public static implicit operator Key<TEntity, TKey>(in TKey value)
Parameters
Type Name Description
TKey value
Returns
Type Description
Key<TEntity, TKey>
| Improve this Doc View Source

Implicit(Key<TEntity, TKey> to TKey)

Declaration
public static implicit operator TKey(in Key<TEntity, TKey> key)
Parameters
Type Name Description
Key<TEntity, TKey> key
Returns
Type Description
TKey
| Improve this Doc View Source

Inequality(Key<TEntity, TKey>, Key<TEntity, TKey>)

Declaration
public static bool operator !=(in Key<TEntity, TKey> a, in Key<TEntity, TKey> b)
Parameters
Type Name Description
Key<TEntity, TKey> a
Key<TEntity, TKey> b
Returns
Type Description
Boolean

Explicit Interface Implementations

| Improve this Doc View Source

IKey.BoxedValue

Declaration
object? IKey.BoxedValue { get; }
Returns
Type Description
Nullable<Object>
| Improve this Doc View Source

IKey<TEntity, TKey>.Value

Declaration
TKey IKey<TEntity, TKey>.Value { get; }
Returns
Type Description
TKey

Implements

IEquatable<>