SortDescriptor

@frozen
public struct SortDescriptor
extension SortDescriptor: CustomStringConvertible
extension SortDescriptor: Equatable
extension SortDescriptor: ExpressibleByStringLiteral

A SortDescriptor stores a key path and a sort order for use with sorted(sortDescriptors:). It is similar to NSSortDescriptor, but supports only the subset of functionality which can be efficiently run by Realm’s query engine.

Show on GitHub

Properties

  • The key path which the sort descriptor orders results by.

    Declaration

    Swift

    public let keyPath: String
    Show on GitHub

  • Whether this descriptor sorts in ascending or descending order.

    Declaration

    Swift

    public let ascending: Bool
    Show on GitHub

Initializers

  • Creates a sort descriptor with the given key path and sort order values.

    Declaration

    Swift

    public init(keyPath: String, ascending: Bool = true)

    Parameters

    keyPath

    The key path which the sort descriptor orders results by.
    ascending

    Whether the descriptor sorts in ascending or descending order.
    Show on GitHub

  • Creates a sort descriptor with the given key path and sort order values.

    Declaration

    Swift

    public init<Element>(keyPath: PartialKeyPath<Element>, ascending: Bool = true) where Element : ObjectBase

    Parameters

    keyPath

    The key path which the sort descriptor orders results by.
    ascending

    Whether the descriptor sorts in ascending or descending order.
    Show on GitHub

Functions

  • Returns a copy of the sort descriptor with the sort order reversed.

    Declaration

    Swift

    public func reversed() -> SortDescriptor
    Show on GitHub

CustomStringConvertible

  • A human-readable description of the sort descriptor.

    Declaration

    Swift

    public var description: String { get }
    Show on GitHub

Equatable

  • Returns whether the two sort descriptors are equal.

    Declaration

    Swift

    public static func == (lhs: SortDescriptor, rhs: SortDescriptor) -> Bool
    Show on GitHub

StringLiteralConvertible