Show / Hide Table of Contents

    Struct ShardKey<TShard, TRecord>

    Immutable class representing a sharded record with a “compound” key: the (virtual) shardId and the (database) recordId.

    Implements
    System.IEquatable<ShardKey<TShard, TRecord>>
    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: ArgentSea
    Assembly: ArgentSea.dll
    Syntax
    public struct ShardKey<TShard, TRecord> : IEquatable<ShardKey<TShard, TRecord>> where TShard : IComparable where TRecord : IComparable
    Type Parameters
    Name Description
    TShard
    TRecord

    Constructors

    | Improve this Doc View Source

    ShardKey(DataOrigin, TShard, TRecord)

    Declaration
    public ShardKey(DataOrigin origin, TShard shardId, TRecord recordId)
    Parameters
    Type Name Description
    DataOrigin origin
    TShard shardId
    TRecord recordId
    | Improve this Doc View Source

    ShardKey(Char, TShard, TRecord)

    Declaration
    public ShardKey(char dataOrigin, TShard shardId, TRecord recordId)
    Parameters
    Type Name Description
    System.Char dataOrigin
    TShard shardId
    TRecord recordId

    Properties

    | Improve this Doc View Source

    Empty

    Declaration
    public static ShardKey<TShard, TRecord> Empty { get; }
    Property Value
    Type Description
    ShardKey<TShard, TRecord>
    | Improve this Doc View Source

    IsEmpty

    Declaration
    public bool IsEmpty { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Origin

    Declaration
    public DataOrigin Origin { get; }
    Property Value
    Type Description
    DataOrigin
    | Improve this Doc View Source

    RecordId

    Declaration
    public TRecord RecordId { get; }
    Property Value
    Type Description
    TRecord
    | Improve this Doc View Source

    ShardId

    Declaration
    public TShard ShardId { get; }
    Property Value
    Type Description
    TShard

    Methods

    | Improve this Doc View Source

    Equals(ShardKey<TShard, TRecord>)

    Declaration
    public bool Equals(ShardKey<TShard, TRecord> other)
    Parameters
    Type Name Description
    ShardKey<TShard, TRecord> other
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.ValueType.Equals(System.Object)
    | Improve this Doc View Source

    FromExternalString(String)

    Declaration
    public static ShardKey<TShard, TRecord> FromExternalString(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    ShardKey<TShard, TRecord>
    | Improve this Doc View Source

    GetHashCode()

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

    ToExternalString()

    Serializes ShardKey data into a URL-safe string with a checksum

    Declaration
    public string ToExternalString()
    Returns
    Type Description
    System.String

    A string which includes the concurrency stamp if defined and includeConcurrencyStamp is true, otherwise returns a smaller string .

    | Improve this Doc View Source

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.ValueType.ToString()

    Operators

    | Improve this Doc View Source

    Equality(ShardKey<TShard, TRecord>, ShardKey<TShard, TRecord>)

    Declaration
    public static bool operator ==(ShardKey<TShard, TRecord> sk1, ShardKey<TShard, TRecord> sk2)
    Parameters
    Type Name Description
    ShardKey<TShard, TRecord> sk1
    ShardKey<TShard, TRecord> sk2
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Inequality(ShardKey<TShard, TRecord>, ShardKey<TShard, TRecord>)

    Declaration
    public static bool operator !=(ShardKey<TShard, TRecord> sk1, ShardKey<TShard, TRecord> sk2)
    Parameters
    Type Name Description
    ShardKey<TShard, TRecord> sk1
    ShardKey<TShard, TRecord> sk2
    Returns
    Type Description
    System.Boolean

    Implements

    System.IEquatable<T>
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX