RealmCollection
public protocol RealmCollection : RealmCollectionBase
可以检索、筛选、排序和操作的Object
的同质collection。
-
托管collection的 Realm,或
nil
(表示非托管collection)。声明
Swift
var realm: Realm? { get }
-
指示是否无法再访问该collection。
如果对管理集合的
Realm
调用了invalidate()
,则无法再访问该集合。声明
Swift
var isInvalidated: Bool { get }
-
collection中的对象的数量。
声明
Swift
var count: Int { get }
-
对collection中包含的对象的人类可读描述。
声明
Swift
var description: String { get }
-
返回对象在collection中的索引,如果该对象不存在,则返回
nil
。声明
Swift
func index(of object: Element) -> Int?
参数
object
一个对象。
-
返回与谓词匹配的第一个对象的索引,如果没有对象匹配,则返回
nil
。声明
Swift
func index(matching predicate: NSPredicate) -> Int?
参数
predicate
用于筛选对象的谓词。
-
index(matching:
默认实现_: ) 返回与谓词匹配的第一个对象的索引,如果没有对象匹配,则返回
nil
。默认实现
返回与给定谓词匹配的第一个对象的索引,如果没有对象匹配,则返回
nil
。声明
Swift
func index(matching predicateFormat: String, _ args: Any...) -> Int?
参数
predicateFormat
谓词格式字符串,可以选择后跟可变数量的参数。
-
filter(_:
默认实现_: )
-
返回包含collection中的对象的
Results
,但已排序。对象根据给定键路径的值进行排序。 例如,要根据
Student
age
属性对collection从新到旧进行排序,您可以调用students.sorted(byKeyPath: "age", ascending: true)
。警告
collection只能按boolean、
Date
、NSDate
、单精度和双精度浮点、整数和字符串类型的属性进行排序。声明
Swift
func sorted(byKeyPath keyPath: String, ascending: Bool) -> Results<Element>
参数
keyPath
排序依据的键路径。
ascending
排序的方向。
-
返回包含collection中的对象的
Results
,但已排序。警告
collection只能按boolean、
Date
、NSDate
、单精度和双精度浮点、整数和字符串类型的属性进行排序。声明
Swift
func sorted<S>(by sortDescriptors: S) -> Results<Element> where S : Sequence, S.Element == SortDescriptor
参数
sortDescriptors
作为排序依据的
SortDescriptor
序列。
-
返回集合中所有对象中给定属性的最小值,如果集合为空,则返回
nil
。警告
只能指定类型符合
MinMaxType
协议的属性。声明
Swift
func min<T>(ofProperty property: String) -> T? where T : MinMaxType
参数
property
所需最小值的属性名称。
-
返回集合中所有对象中给定属性的最大值,如果集合为空,则返回
nil
。警告
只能指定类型符合
MinMaxType
协议的属性。声明
Swift
func max<T>(ofProperty property: String) -> T? where T : MinMaxType
参数
property
所需最小值的属性名称。
-
返回集合中对象的给定属性的总和,如果集合为空,则返回
nil
。警告
只能使用符合
AddableType
协议的类型的属性名称。声明
Swift
func sum<T>(ofProperty property: String) -> T where T : AddableType
参数
property
符合
AddableType
的属性名称,用于计算总和。 -
返回集合中所有对象的给定属性的平均值,如果集合为空,则返回
nil
。警告
只能指定类型符合
AddableType
协议的属性。声明
Swift
func average<T>(ofProperty property: String) -> T? where T : AddableType
参数
property
应对其值求和的属性的名称。
-
返回一个
Array
,其中包含对集合的每个对象调用valueForKey(_:)
和key
的结果。声明
Swift
func value(forKey key: String) -> Any?
参数
key
所需值的属性的名称。
-
返回一个
Array
,其中包含对集合的每个对象调用valueForKeyPath(_:)
和keyPath
的结果。声明
Swift
func value(forKeyPath keyPath: String) -> Any?
参数
keyPath
所需值属性的键路径。
-
setValue(_:forKey:)
使用指定的value
和 在集合的每个对象上调用key
。警告
此方法只能在写事务(write transaction)期间调用。
声明
Swift
func setValue(_ value: Any?, forKey key: String)
参数
value
对象值。
key
应在每个对象上设置其值的属性的名称。
-
注册一个区块,以便在每次collection更改时调用。
该区块将与初始结果一起异步调用,然后在每次写事务(write transaction)后再次调用,这会更改collection中的任何对象或collection中的哪些对象。
传递给区块的
change
参数以collection内索引的形式报告在每个写事务(write transaction)期间添加、删除或修改了哪些对象。有关所提供变更信息的更多信息,以及如何使用这些信息来更新UITableView
的示例,请参阅RealmCollectionChange
文档。调用区块时,collection将进行全面求值且是最新的,只要不在同一线程上执行写事务(write transaction)或显式调用
realm.refresh()
,访问该collection就永远不会执行阻塞工作。如果未指定队列,则将通过标准事件循环传递通知,因此当事件循环被其他活动阻塞时无法传递通知。如果给出了队列,则将通知传递到该队列。 当无法立即传递通知时,可以将多个通知合并为一个通知。 这可以包括初始collection的通知。
例如,以下代码在添加通知块后立即执行写事务(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 为只读时,无法调用此方法。
声明
Swift
func observe(on queue: DispatchQueue?, _ block: @escaping (RealmCollectionChange<Self>) -> Void) -> NotificationToken
参数
queue
用于接收通知的串行调度队列。 如果为
nil
,则通知将传递到当前线程。block
发生更改时要调用的区块。
返回值
只要您希望传递更新,就必须持有的令牌。
-
如果此集合已冻结,则返回
声明
Swift
var isFrozen: Bool { get }
-
返回此collection的冻结(不可变)快照。
冻结副本是一个不可变的collection,其中包含与该collection当前包含的数据相同的数据,但在写入包含的 Realm 时不会更新。与实时集合不同,冻结集合可以从任何线程访问。
警告
在写事务(write transaction)期间或当包含的 Realm 为只读时,无法调用此方法。警告
在 Realm 上执行写事务(write transaction)时长时间持有冻结的 collection 可能会导致 Realm 文件过大。有关更多信息,请参阅Realm.Configuration.maximumNumberOfActiveVersions
。声明
Swift
func freeze() -> Self
-
返回此冻结collection的活动(可变)版本。
此方法解析对同一冻结collection的实时副本的引用。如果在实时collection上调用,则返回自身。
声明
Swift
func thaw() -> Self?
-
objectWillChange
扩展方法每次collection更改时发出 Void 的发布者。
尽管有这个名称,但它实际上是在collection发生更改后发出的。
声明
Swift
public var objectWillChange: RealmPublishers.WillChange<Self> { get }
-
collectionPublisher
扩展方法每次集合更改时发出集合的发布者。
声明
Swift
public var collectionPublisher: RealmPublishers.Value<Self> { get }
-
changesetPublisher
扩展方法每次集合更改时发出集合变更集的发布者。
声明
Swift
public var changesetPublisher: RealmPublishers.CollectionChangeset<Self> { get }
-
sum()
扩展方法返回集合中值的总和,如果集合为空,则返回
nil
。声明
Swift
func sum() -> Element
-
average()
扩展方法返回集合中所有值的平均值。
声明
Swift
func average<T>() -> T? where T : AddableType
-
sum()
扩展方法返回集合中值的总和,如果集合为空,则返回
nil
。声明
Swift
func sum() -> Element.Wrapped
-
average()
扩展方法返回集合中所有值的平均值。
声明
Swift
func average<T>() -> T? where T : AddableType
-
sorted(ascending:
扩展方法)
-
sorted(ascending:
扩展方法)