RealmCollection

public protocol RealmCollection : RealmCollectionBase

검색, 필터링, 정렬 및 연산이 가능한 Object의 동질적인 컬렉션입니다.

속성

  • 컬렉션을 관리하는 Realm이거나 관리되지 않는 컬렉션의 경우 nil 입니다.

    선언

    스위프트

    var realm: Realm? { get }
  • collection에 더 이상 액세스할 수 없는지 여부를 나타냅니다.

    collection을 managed하는 Realm 에서 invalidate() 가 호출된 경우 collection에 더 이상 액세스할 수 없습니다.

    선언

    스위프트

    var isInvalidated: Bool { get }
  • collection의 객체 수입니다.

    선언

    스위프트

    var count: Int { get }
  • collection에 포함된 객체에 대한 사람이 읽을 수 있는 설명입니다.

    선언

    스위프트

    var description: String { get }

인덱스 검색

  • collection에 있는 객체의 인덱스를 반환하거나, 객체가 없는 경우 nil 을 반환합니다.

    선언

    스위프트

    func index(of object: Element) -> Int?

    매개변수

    object

    객체입니다.

  • 조건자와 일치하는 첫 번째 객체의 인덱스를 반환하거나, 일치하는 객체가 없는 경우 nil 를 반환합니다.

    선언

    스위프트

    func index(matching predicate: NSPredicate) -> Int?

    매개변수

    predicate

    객체를 필터링하는 데 사용할 조건자입니다.

  • index(matching:_:) 기본 구현

    조건자와 일치하는 첫 번째 객체의 인덱스를 반환하거나, 일치하는 객체가 없는 경우 nil 를 반환합니다.

    기본 구현

    지정된 조건자와 일치하는 첫 번째 객체의 인덱스를 반환하거나 일치하는 객체가 없는 경우 nil 를 반환합니다.

    선언

    스위프트

    func index(matching predicateFormat: String, _ args: Any...) -> Int?

    매개변수

    predicateFormat

    조건자 형식 문자열이며, 선택적으로 그 뒤에 다양한 수의 인수가 옵니다.

필터링

  • filter(_:_:) 기본 구현

    컬렉션에서 지정된 조건자와 일치하는 모든 객체를 포함하는 Results 를 반환합니다.

    기본 구현

    컬렉션에서 지정된 조건자와 일치하는 모든 객체를 포함하는 Results 를 반환합니다.

    선언

    스위프트

    func filter(_ predicateFormat: String, _ args: Any...) -> Results<Element>

    매개변수

    predicateFormat

    조건자 형식 문자열이며, 선택적으로 그 뒤에 다양한 수의 인수가 옵니다.

  • 컬렉션에서 지정된 조건자와 일치하는 모든 객체를 포함하는 Results 를 반환합니다.

    선언

    스위프트

    func filter(_ predicate: NSPredicate) -> Results<Element>

    매개변수

    predicate

    객체를 필터링하는 데 사용할 조건자입니다.

정렬

  • collection에 있지만 정렬된 객체를 포함하는 Results 을 반환합니다.

    객체는 지정된 키 경로의 값을 기준으로 정렬됩니다. 예를 들어, Studentcollection을 age 속성을 기준으로 가장 오래된 것부터 가장 오래된 것 순으로 정렬하려면 students.sorted(byKeyPath: "age", ascending: true) 를 호출할 수 있습니다.

    경고

    collection은 부울, Date, NSDate, 단일 및 배정밀도 부동 소수점, 정수, 문자열 유형의 속성을 통해서만 정렬할 수 있습니다.

    선언

    스위프트

    func sorted(byKeyPath keyPath: String, ascending: Bool) -> Results<Element>

    매개변수

    keyPath

    정렬 기준이 되는 키 경로입니다.

    ascending

    정렬할 방향입니다.

  • collection에 있지만 정렬된 객체를 포함하는 Results 을 반환합니다.

    경고

    collection은 부울, Date, NSDate, 단일 및 배정밀도 부동 소수점, 정수, 문자열 유형의 속성을 통해서만 정렬할 수 있습니다.

    ~를 참조하세요.

    sorted(byKeyPath:ascending:)

    선언

    스위프트

    func sorted<S>(by sortDescriptors: S) -> Results<Element> where S : Sequence, S.Element == SortDescriptor

    매개변수

    sortDescriptors

    정렬 기준이 되는 SortDescriptor의 시퀀스입니다.

집계 작업

  • collection의 모든 객체 중 지정된 속성의 최소값(최저)을 반환하거나 collection이 비어 있는 경우 nil 를 반환합니다.

    경고

    유형이 MinMaxType 프로토콜을 준수하는 속성만 지정할 수 있습니다.

    선언

    스위프트

    func min<T>(ofProperty property: String) -> T? where T : MinMaxType

    매개변수

    property

    최소값을 원하는 속성의 이름입니다.

  • 컬렉션의 모든 객체 중 지정된 속성의 최대값(가장 높은 값)을 반환하거나, 컬렉션이 비어 있는 경우 nil 를 반환합니다.

    경고

    유형이 MinMaxType 프로토콜을 준수하는 속성만 지정할 수 있습니다.

    선언

    스위프트

    func max<T>(ofProperty property: String) -> T? where T : MinMaxType

    매개변수

    property

    최소값을 원하는 속성의 이름입니다.

  • collection에 있는 객체에 지정된 속성의 합계를 반환하거나 collection이 비어 있는 경우 nil 를 반환합니다.

    경고

    AddableType 프로토콜을 준수하는 유형의 속성 이름만 사용할 수 있습니다.

    선언

    스위프트

    func sum<T>(ofProperty property: String) -> T where T : AddableType

    매개변수

    property

    합계를 계산할 AddableType 을(를) 준수하는 속성의 이름입니다.

  • collection의 모든 객체에 대한 지정된 속성의 평균값을 반환하거나 collection이 비어 있는 경우 nil 를 반환합니다.

    경고

    유형이 AddableType 프로토콜을 준수하는 속성만 지정할 수 있습니다.

    선언

    스위프트

    func average<T>(ofProperty property: String) -> T? where T : AddableType

    매개변수

    property

    값을 합산해야 하는 속성의 이름입니다.

키-값 코딩

  • 컬렉션의 각 객체에 대해 keyvalueForKey(_:) 를 호출한 결과가 포함된 Array 을 반환합니다.

    선언

    스위프트

    func value(forKey key: String) -> Any?

    매개변수

    key

    값을 원하는 속성의 이름입니다.

  • 컬렉션의 각 객체에 대해 keyPathvalueForKeyPath(_:) 를 호출한 결과가 포함된 Array 을 반환합니다.

    선언

    스위프트

    func value(forKeyPath keyPath: String) -> Any?

    매개변수

    keyPath

    값을 원하는 속성의 키 경로입니다.

  • 지정된 valuekey 를 사용하여 컬렉션의 각 객체에 대해 setValue(_:forKey:) 을(를) 호출합니다.

    경고

    이 메서드는 쓰기 트랜잭션(write transaction) 중에만 호출할 수 있습니다.

    선언

    스위프트

    func setValue(_ value: Any?, forKey key: String)

    매개변수

    value

    객체 값입니다.

    key

    각 객체에 값을 설정해야 하는 속성의 이름입니다.

알림

  • collection이 변경될 때마다 호출될 블록을 등록합니다.

    블록은 초기 결과와 함께 비동기적으로 호출된 다음 컬렉션의 객체 또는 컬렉션에 있는 객체를 변경하는 각 쓰기 트랜잭션(write transaction) 후에 다시 호출됩니다.

    블록에 전달되는 change 매개변수는 각 쓰기 트랜잭션(write transaction) 중에 추가, 제거 또는 수정된 객체를 collection 내에서 인덱스 형식으로 보고합니다. 제공된 변경 정보에 대한 자세한 내용과 이를 사용하여 UITableView 을 업데이트하는 방법에 대한 예는 RealmCollectionChange 문서를 참조하세요.

    차단이 호출되는 시점에 collection은 완전히 평가되고 최신 상태이므로 동일한 스레드에서 쓰기 트랜잭션 (write transaction)을 수행하지 않거나 명시적으로 realm.refresh() 호출하지 않는 한 해당 스레드에 액세스하면 차단이 수행되지 않습니다. 일.

    대기열이 제공되지 않으면 표준 이벤트 루프를 통해 알림이 전달되므로 이벤트 루프가 다른 활동에 의해 차단되는 동안에는 알림을 전달할 수 없습니다. 대기열이 제공되면 대신 해당 대기열로 알림이 전달됩니다. 알림을 즉시 전달할 수 없는 경우 여러 알림이 단일 알림으로 병합될 수 있습니다. 여기에는 초기 collection에 대한 알림이 포함될 수 있습니다.

    예를 들어 다음 코드는 알림 차단을 추가한 직후 쓰기 트랜잭션(write transaction)을 수행하므로 초기 알림이 먼저 전달될 기회가 없습니다. 결과적으로 초기 알림에는 쓰기 트랜잭션(write transaction) 후 Realm의 상태가 반영됩니다.

    let results = realm.objects(Dog.self)
    print("dogs.count: \(dogs?.count)") // => 0
    let token = dogs.observe { changes in
    switch changes {
        case .initial(let dogs):
            // Will print "dogs.count: 1"
            print("dogs.count: \(dogs.count)")
            break
        case .update:
            // Will not be hit in this example
            break
        case .error:
            break
        }
    }
    try! realm.write {
        let dog = Dog()
        dog.name = "Rex"
        person.dogs.append(dog)
    }
    // end of run loop execution context
    

    블록에 업데이트를 전송하려는 한 반환된 토큰을 보관해야 합니다. 업데이트 수신을 중지하려면 토큰에서 invalidate() 을 호출합니다.

    경고

    쓰기 트랜잭션(write transaction) 중에는 또는 포함하는 Realm이 읽기 전용일 때 이 메서드를 호출할 수 없습니다.

    선언

    스위프트

    func observe(on queue: DispatchQueue?, _ block: @escaping (RealmCollectionChange<Self>) -> Void) -> NotificationToken

    매개변수

    queue

    알림을 수신할 직렬 디스패치 대기열입니다. nil 인 경우 알림이 현재 스레드로 전달됩니다.

    block

    변경이 발생할 때마다 호출되는 차단입니다.

    반환 값

    업데이트가 전달되기를 원하는 기간 동안 보유해야 하는 토큰입니다.

동결된 객체

  • 이 collection이 동결된 경우 반환

    선언

    스위프트

    var isFrozen: Bool { get }
  • 이 collection의 동결(불변) 스냅샷을 반환합니다.

    동결 사본은 변경이 불가능한 collection으로 이 collection이 현재 포함하고 있는 것과 동일한 데이터를 포함하지만 포함 Realm에 기록할 때 업데이트되지 않습니다. 라이브 collection과 달리 동결 collection은 모든 스레드에서 액세스할 수 있습니다.

    경고

    쓰기 트랜잭션(write transaction) 중에는 또는 포함하는 Realm이 읽기 전용일 때 이 메서드를 호출할 수 없습니다.

    경고

    Realm에서 쓰기 트랜잭션(write transaction)을 수행하는 동안 동결된 컬렉션을 오랫동안 유지하면 Realm 파일 크기가 커질 수 있습니다. 자세한 내용은 Realm.Configuration.maximumNumberOfActiveVersions 를 참조하세요.

    선언

    스위프트

    func freeze() -> Self
  • 이 동결 collection의 라이브(변경 가능) 버전을 반환합니다.

    이 메서드는 동일한 동결 컬렉션의 라이브 사본에 대한 참조를 확인합니다. 라이브 컬렉션에서 호출하면 자체를 반환합니다.

    선언

    스위프트

    func thaw() -> Self?

Self: RealmSubscribable에서 사용 가능

  • objectWillChange 확장 메서드

    collection이 변경될 때마다 Void를 방출하는 출판사입니다.

    이름과 달리 실제로 collection 변경된 후에 방출합니다.

    선언

    스위프트

    public var objectWillChange: RealmPublishers.WillChange<Self> { get }
  • collectionPublisher 확장 메서드

    컬렉션이 변경될 때마다 컬렉션을 방출하는 출판사입니다.

    선언

    스위프트

    public var collectionPublisher: RealmPublishers.Value<Self> { get }
  • changesetPublisher 확장 메서드

    컬렉션이 변경될 때마다 컬렉션 변경 집합을 내보내는 출판사입니다.

    선언

    스위프트

    public var changesetPublisher: RealmPublishers.CollectionChangeset<Self> { get }

Element: MinMaxType에서 사용 가능

  • min() 확장 메서드

    collection의 최소값(가장 낮은 값)을 반환하거나, collection이 비어 있는 경우 nil 을 반환합니다.

    선언

    스위프트

    func min() -> Element?
  • max() 확장 메서드

    컬렉션의 최대값(가장 높은 값)을 반환하거나, 컬렉션이 비어 있는 경우 nil 를 반환합니다.

    선언

    스위프트

    func max() -> Element?

Element: OptionalProtocol, Element.Wrapped: MinMaxType에서 사용 가능

  • min() 확장 메서드

    collection의 최소값(가장 낮은 값)을 반환하거나, collection이 비어 있는 경우 nil 을 반환합니다.

    선언

    스위프트

    func min() -> Element.Wrapped?
  • max() 확장 메서드

    컬렉션의 최대값(가장 높은 값)을 반환하거나, 컬렉션이 비어 있는 경우 nil 를 반환합니다.

    선언

    스위프트

    func max() -> Element.Wrapped?

Element: AddableType에서 사용 가능

  • sum() 확장 메서드

    collection에 있는 값의 합계를 반환하거나 collection이 비어 있는 경우 nil 을 반환합니다.

    선언

    스위프트

    func sum() -> Element
  • average() 확장 메서드

    컬렉션에 있는 모든 값의 평균을 반환합니다.

    선언

    스위프트

    func average<T>() -> T? where T : AddableType

Element: OptionalProtocol, Element.Wrapped: AddableType에서 사용 가능

  • sum() 확장 메서드

    collection에 있는 값의 합계를 반환하거나 collection이 비어 있는 경우 nil 을 반환합니다.

    선언

    스위프트

    func sum() -> Element.Wrapped
  • average() 확장 메서드

    컬렉션에 있는 모든 값의 평균을 반환합니다.

    선언

    스위프트

    func average<T>() -> T? where T : AddableType

Element: Comparable에서 사용 가능

  • sorted(ascending:) 확장 메서드

    collection에 있지만 정렬된 객체를 포함하는 Results 을 반환합니다.

    객체는 해당 값을 기준으로 정렬됩니다. 예를 들어, Datecollection을 최신 항목에서 가장 오래된 항목 순으로 정렬하려면 dates.sorted(ascending: true) 을(를) 호출할 수 있습니다.

    선언

    스위프트

    func sorted(ascending: Bool = true) -> Results<Element>

    매개변수

    ascending

    정렬할 방향입니다.

Element: OptionalProtocol, Element.Wrapped: Comparable에서 사용 가능

  • sorted(ascending:) 확장 메서드

    collection에 있지만 정렬된 객체를 포함하는 Results 을 반환합니다.

    객체는 해당 값을 기준으로 정렬됩니다. 예를 들어, Datecollection을 최신 항목에서 가장 오래된 항목 순으로 정렬하려면 dates.sorted(ascending: true) 을(를) 호출할 수 있습니다.

    선언

    스위프트

    func sorted(ascending: Bool = true) -> Results<Element>

    매개변수

    ascending

    정렬할 방향입니다.