RealmOptional

@available(*, deprecated, renamed: "RealmProperty", message: "RealmOptional<T> has been deprecated, use RealmProperty<T?> instead.")
public final class RealmOptional<Value> : RLMSwiftValueStorage where Value : RealmOptionalType
extension RealmOptional: SchemaDiscoverable, _RealmSchemaDiscoverable where Value: _RealmSchemaDiscoverable
extension RealmOptional: Equatable where Value: Equatable
extension RealmOptional: Codable where Value: Codable, Value: _RealmSchemaDiscoverable

A RealmOptional instance represents an optional value for types that can’t be directly declared as @objc in Swift, such as Int, Float, Double, and Bool.

To change the underlying value stored by a RealmOptional instance, mutate the instance’s value property.

Show on GitHub

  • The value the optional represents.

    Declaration

    Swift

    public var value: Value? { get set }
    Show on GitHub

  • Creates a RealmOptional instance encapsulating the given default value.

    Declaration

    Swift

    public init(_ value: Value? = nil)

    Parameters

    value

    The value to store in the optional, or nil if not specified.
    Show on GitHub

Available where Value: _RealmSchemaDiscoverable

Available where Value: Equatable

  • Declaration

    Swift

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

Available where Value: Codable, Value: _RealmSchemaDiscoverable