?>(update: { data in
57 | XCTAssertNotNil(data)
58 | if case .failure(let error) = data! {
59 | if let err = error as? TestError {
60 | XCTAssert(err == .test)
61 | } else {
62 | XCTFail()
63 | }
64 | } else {
65 | XCTFail()
66 | }
67 | exp.fulfill()
68 | })
69 |
70 | liveData.observeForever(observer: observer)
71 | liveData.data = .failure(TestError.test)
72 |
73 | waitForExpectations(timeout: 10, handler: nil)
74 |
75 | }
76 |
77 | static var allTests = [
78 | ("testFailureState", testFailureState),
79 | ("testSuccessState", testSuccessState),
80 | ]
81 | }
82 |
83 | enum TestError: Swift.Error {
84 | case test
85 | }
86 |
87 |
--------------------------------------------------------------------------------
/ETBinding.xcodeproj/xcshareddata/xcschemes/ETBinding-watchOS.xcscheme:
--------------------------------------------------------------------------------
1 |
2 |
5 |
8 |
9 |
15 |
21 |
22 |
23 |
24 |
25 |
31 |
32 |
33 |
34 |
35 |
36 |
46 |
47 |
53 |
54 |
55 |
56 |
57 |
58 |
64 |
65 |
71 |
72 |
73 |
74 |
76 |
77 |
80 |
81 |
82 |
--------------------------------------------------------------------------------
/ETBinding.xcodeproj/xcshareddata/xcschemes/ETBinding-iOS.xcscheme:
--------------------------------------------------------------------------------
1 |
2 |
5 |
8 |
9 |
15 |
21 |
22 |
23 |
24 |
25 |
31 |
32 |
34 |
40 |
41 |
42 |
43 |
44 |
50 |
51 |
52 |
53 |
54 |
55 |
65 |
66 |
72 |
73 |
74 |
75 |
76 |
77 |
83 |
84 |
90 |
91 |
92 |
93 |
95 |
96 |
99 |
100 |
101 |
--------------------------------------------------------------------------------
/ETBinding.xcodeproj/xcshareddata/xcschemes/ETBinding-tvOS.xcscheme:
--------------------------------------------------------------------------------
1 |
2 |
5 |
8 |
9 |
15 |
21 |
22 |
23 |
24 |
25 |
31 |
32 |
34 |
40 |
41 |
42 |
43 |
44 |
50 |
51 |
52 |
53 |
54 |
55 |
65 |
66 |
72 |
73 |
74 |
75 |
76 |
77 |
83 |
84 |
90 |
91 |
92 |
93 |
95 |
96 |
99 |
100 |
101 |
--------------------------------------------------------------------------------
/ETBinding.xcodeproj/xcshareddata/xcschemes/ETBinding-macOS.xcscheme:
--------------------------------------------------------------------------------
1 |
2 |
5 |
8 |
9 |
15 |
21 |
22 |
23 |
24 |
25 |
31 |
32 |
34 |
40 |
41 |
42 |
43 |
44 |
50 |
51 |
52 |
53 |
54 |
55 |
65 |
66 |
72 |
73 |
74 |
75 |
76 |
77 |
83 |
84 |
90 |
91 |
92 |
93 |
95 |
96 |
99 |
100 |
101 |
--------------------------------------------------------------------------------
/docs/docsets/ETLiveData.docset/Contents/Resources/Documents/search.json:
--------------------------------------------------------------------------------
1 | {"Enums/StateValue.html#/s:10ETLiveData10StateValueO7successACyxGxcAEmlF":{"name":"success","abstract":"Success value
","parent_name":"StateValue"},"Enums/StateValue.html#/s:10ETLiveData10StateValueO7failureACyxGs5Error_pcAEmlF":{"name":"failure","abstract":"Error for failured value
","parent_name":"StateValue"},"Enums/LifecycleState.html#/s:10ETLiveData14LifecycleStateO6activeA2CmF":{"name":"active","abstract":"Indicates that LifecycleOwner is still alive
","parent_name":"LifecycleState"},"Enums/LifecycleState.html#/s:10ETLiveData14LifecycleStateO9destroyedA2CmF":{"name":"destroyed","abstract":"Indicates that LifecycleOwner is already deallocated
","parent_name":"LifecycleState"},"Enums/LifecycleState.html":{"name":"LifecycleState","abstract":"Valid states of LifecycleOwner
"},"Enums/StateValue.html":{"name":"StateValue","abstract":"Value with state added
"},"Classes/LiveData.html#/s:10ETLiveData04LiveB0C4dataxSgv":{"name":"data","abstract":"The current value that is dispatched after assignment.
","parent_name":"LiveData"},"Classes/LiveData.html#/s:10ETLiveData04LiveB0CACyxGxSg4data_tcfc":{"name":"init(data:)","abstract":"Initializes LiveData with given data.
","parent_name":"LiveData"},"Classes/LiveData.html#/s:10ETLiveData04LiveB0C7observe10ETObserver8ObserverCyxSgGyXl5owner_yAHc8onUpdatetF":{"name":"observe(owner:onUpdate:)","abstract":"Starts observing changes of data
Starts observing changes of data
Starts observing changes of data remove(observer:)
","parent_name":"LiveData"},"Classes/LiveData.html#/s:10ETLiveData04LiveB0C14observeForever10ETObserver8ObserverCyxSgGAI8observer_tF":{"name":"observeForever(observer:)","abstract":"Starts observing changes of data remove(observer:)
","parent_name":"LiveData"},"Classes/LiveData.html#/s:10ETLiveData04LiveB0C6removeSb10ETObserver8ObserverCyxSgG8observer_tF":{"name":"remove(observer:)","abstract":"Unregister given observer from data
","parent_name":"LiveData"},"Classes/LiveData.html#/s:10ETLiveData04LiveB0C8dispatchy10ETObserver8ObserverCyxSgGSg9initiator_tF":{"name":"dispatch(initiator:)","abstract":"Dispatches current value to observers that don’t have it still.
","parent_name":"LiveData"},"Classes.html#/s:10ETLiveData09LiveStateB0C":{"name":"LiveStateData","abstract":"Wraps generic value from LiveData StateValue
LiveData is an observable data holder class. Unlike a regular observable,"},"Classes.html":{"name":"Classes","abstract":"
The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"}}
--------------------------------------------------------------------------------
/docs/Structs.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Structures Reference
5 |
20 |
21 | ETLiveData Reference
22 |
25 |
27 |
72 |
73 |
74 |
75 | Structures
76 | The following structures are available globally.
77 |
78 |
79 |
80 |
81 |
82 |
83 |
90 |
91 |
92 |
93 |
94 |
95 |
Utility functions that can replace and restore the fatalError global function.
96 |
97 |
See more
98 |
100 |
Declaration
101 |
102 |
Swift
103 |
public struct FatalErrorUtil
104 |
105 |
106 |
108 |
110 |
111 |
113 |
114 |
118 |
119 |
Structures Reference
5 |
20 |
21 | ETLiveData Reference
22 |
25 |
27 |
72 |
73 |
74 |
75 | Structures
76 | The following structures are available globally.
77 |
78 |
79 |
80 |
81 |
82 |
83 |
90 |
91 |
92 |
93 |
94 |
95 |
Utility functions that can replace and restore the fatalError global function.
96 |
97 |
See more
98 |
100 |
Declaration
101 |
102 |
Swift
103 |
public struct FatalErrorUtil
104 |
105 |
106 |
108 |
110 |
111 |
113 |
114 |
118 |
119 |
Structures Reference
5 |
20 |
21 | ETLiveData Reference
22 |
25 |
27 |
72 |
73 |
74 |
75 | Structures
76 | The following structures are available globally.
77 |
78 |
79 |
80 |
81 |
82 |
83 |
90 |
91 |
92 |
93 |
94 |
95 |
Utility functions that can replace and restore the fatalError global function.
96 |
97 |
See more
98 |
100 |
Declaration
101 |
102 |
Swift
103 |
public struct FatalErrorUtil
104 |
105 |
106 |
108 |
110 |
111 |
113 |
114 |
118 |
119 |
Enumerations Reference
5 |
20 |
21 | ETLiveData Reference
22 |
25 |
27 |
53 |
54 |
55 |
56 | Enumerations
57 | The following enumerations are available globally.
58 |
59 |
60 |
61 |
62 |
63 |
64 |
71 |
72 |
73 |
74 |
75 |
76 |
Valid states of LifecycleOwner
77 |
78 |
See more
79 |
81 |
Declaration
82 |
83 |
Swift
84 |
public enum LifecycleState
85 |
86 |
87 |
89 |
91 |
92 |
94 |
95 |
96 |
103 |
104 |
105 |
106 |
107 |
108 |
Value with state added
109 |
110 |
See more
111 |
113 |
Declaration
114 |
115 |
Swift
116 |
public enum StateValue < Value >
117 |
118 |
119 |
121 |
123 |
124 |
126 |
127 |
131 |
132 |
Type Aliases Reference
5 |
21 |
22 | ETBinding Reference
23 |
26 |
28 |
90 |
91 |
92 |
93 | Type Aliases
94 | The following type aliases are available globally.
95 |
96 |
97 |
98 |
99 |
100 |
101 |
108 |
109 |
110 |
111 |
112 |
113 |
Lifecycle object for which is observer bound to
114 |
115 |
117 |
Declaration
118 |
119 |
Swift
120 |
public typealias LifecycleOwner = AnyObject
121 |
122 |
123 |
125 |
127 |
128 |
130 |
131 |
135 |
136 |
Type Aliases Reference
5 |
21 |
22 | ETBinding Reference
23 |
26 |
28 |
90 |
91 |
92 |
93 | Type Aliases
94 | The following type aliases are available globally.
95 |
96 |
97 |
98 |
99 |
100 |
101 |
108 |
109 |
110 |
111 |
112 |
113 |
Lifecycle object for which is observer bound to
114 |
115 |
117 |
Declaration
118 |
119 |
Swift
120 |
public typealias LifecycleOwner = AnyObject
121 |
122 |
123 |
125 |
127 |
128 |
130 |
131 |
135 |
136 |
LifecycleState Enumeration Reference
5 |
21 |
22 | ETLiveData Reference
23 |
26 |
28 |
54 |
55 |
56 |
57 | LifecycleState
58 |
59 |
60 |
public enum LifecycleState
61 |
62 |
63 |
Valid states of LifecycleOwner
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 | active
76 |
77 |
79 |
80 |
81 |
82 |
83 |
Indicates that LifecycleOwner is still alive
84 |
85 |
87 |
Declaration
88 |
89 |
Swift
90 |
case active
91 |
92 |
93 |
95 |
97 |
98 |
100 |
101 |
102 |
103 |
104 | destroyed
107 |
108 |
110 |
111 |
112 |
113 |
114 |
Indicates that LifecycleOwner is already deallocated
115 |
116 |
118 |
Declaration
119 |
120 |
Swift
121 |
case destroyed
122 |
123 |
124 |
126 |
128 |
129 |
131 |
132 |
136 |
137 |
StateValue Enumeration Reference
5 |
21 |
22 | ETLiveData Reference
23 |
26 |
28 |
54 |
55 |
56 |
57 | StateValue
58 |
59 |
60 |
public enum StateValue < Value >
61 |
62 |
63 |
Value with state added
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 | success
76 |
77 |
79 |
80 |
81 |
82 |
83 |
Success value
84 |
85 |
87 |
Declaration
88 |
89 |
Swift
90 |
case success ( Value )
91 |
92 |
93 |
95 |
97 |
98 |
100 |
101 |
102 |
103 |
104 | failure
107 |
108 |
110 |
111 |
112 |
113 |
114 |
Error for failured value
115 |
116 |
118 |
Declaration
119 |
120 |
Swift
121 |
case failure ( Swift . Error )
122 |
123 |
124 |
126 |
128 |
129 |
131 |
132 |
136 |
137 |
= LiveData()
76 | let observer = liveData.observe(owner: self) { data in
77 | // do something with data
78 | }
79 | // observer can be used for later unregistration
80 | ```
81 |
82 | Update closure can be encapsulated inside `Observer` and after then registered. This pattern could be used when observation will be started in future.
83 |
84 | ```swift
85 | let observer: Observer = Observer(update: { data in
86 | // do something with data
87 | })
88 | // … and later
89 | let liveData: LiveData = LiveData()
90 | liveData.observe(owner: self, observer: observer)
91 | // observer can be used for later unregistration
92 | ```
93 |
94 | ### Observe forever
95 |
96 | Lifecycle owner isn't mandatory all the time. When owner isn't given, unregistration is under your control.
97 |
98 | ```swift
99 | let liveData: LiveData = LiveData()
100 | let observer = liveData.observeForever { data in
101 | // do something with data
102 | }
103 | // observer can be used for later unregistration
104 | ```
105 |
106 | ```swift
107 | let observer: Observer = Observer(update: { data in
108 | // do something with data
109 | })
110 | // … and later
111 | let liveData: LiveData = LiveData()
112 | liveData.observeForever(observer: observer)
113 | // observer can be used for later unregistration
114 | ```
115 |
116 | ### Remove observer
117 |
118 | Unregisters given observer from liveData changes observation.
119 |
120 | ```swift
121 | // … observer is obtained from early called function `observe`
122 | liveData.remove(observer: observer)
123 | ```
124 |
125 | ### Dispatch value to observers
126 |
127 | After observation is started value isn't automatically dispatched to observer. If you want to gain current value, you can read it directly from `data` variable or you can call `dispatch` and update will be delivered to newly registered observers.
128 |
129 | ```swift
130 | // Dispatches value to observers that were registered from last dispatch
131 | liveData.dispatch()
132 |
133 | // Dispatches value to given observer if is newly registered from last dispatch
134 | liveData.dispatch(initiator: observer)
135 | ```
136 |
137 | Every **observer is called only once per new value although `dispatch` is called multiple times**. Value setter is versioned and observer holds last delivered value version and blocks dispatching of version that was already delivered.
138 |
139 | ## Contributing
140 |
141 | Contributions to ETBinding are welcomed and encouraged!
142 |
143 | ## License
144 |
145 | ETBinding is available under the MIT license. See [LICENSE](LICENSE) for more information.
146 |
147 | ## Attributions
148 |
149 | I've used [SwiftPlate](https://github.com/JohnSundell/SwiftPlate) to generate xcodeproj compatible with CocoaPods and Carthage.
150 |
--------------------------------------------------------------------------------
/Sources/ETBinding/FutureEvent/FutureEvent.swift:
--------------------------------------------------------------------------------
1 | //
2 | // FutureEvent.swift
3 | //
4 | // Created by Jan Čislinský on 05. 03. 2018.
5 | // Copyright © 2018 Etnetera. All rights reserved.
6 | //
7 |
8 | import Foundation
9 |
10 | /// `FutureEvent` is an observable event handler class. Unlike a regular observable,
11 | /// `FutureEvent` is lifecycle-aware, meaning it respects the lifecycle of its owner.
12 | /// This awareness ensures `FutureEvent` only triggers app component observers that
13 | /// are in an active lifecycle state.
14 | ///
15 | /// let onPress = FutureEvent()
16 | /// let observer = onPress.observeForever {
17 | /// print("Button pressed")
18 | /// }
19 | /// onPress.trigger()
20 | /// // prints Button pressed
21 | ///
22 | /// onPress.remove(observer: observer)
23 | ///
24 | /// onPress.trigger()
25 | /// // … nothing
26 | public class FutureEvent: Observable, CustomStringConvertible {
27 | public typealias DataType = Action
28 |
29 | // MARK: - Variables
30 | // MARK: public
31 |
32 | public var description: String {
33 | let observersDesc = observers.reduce("") { accum, current in
34 | let desc = "\tid: \(current.hashValue), ownerState: \(current.state), owner: \(String(describing: current.owner))\n"
35 | return accum + desc
36 | }
37 | return """
38 | observers:\n\(observersDesc))
39 | """
40 | }
41 |
42 | // MARK: internal
43 |
44 | var observers: Set> = []
45 |
46 | // MARK: - Initialization
47 |
48 | public init() {}
49 | }
50 |
51 | public extension FutureEvent {
52 | // MARK: - Observe
53 |
54 | /// Starts observation until given owner is alive or `remove(observer:)` is called.
55 | ///
56 | /// - Attention:
57 | /// - After deallocation of owner `onUpdate` will be never called.
58 | /// - Inside of `onUpdate` closure you are alway on main thread.
59 | ///
60 | /// - Parameters:
61 | /// - owner: LifecycleOwner of newly created observation.
62 | /// - onUpdate: Closure that is called on change.
63 | ///
64 | /// - Returns: Observer that represents update block.
65 | @discardableResult func observe(owner: LifecycleOwner, onUpdate: @escaping (DataType) -> Void) -> Observer {
66 | let wrapper = LifecycleBoundObserver(owner: owner, observer: Observer(update: onUpdate))
67 | return observe(wrapper)
68 | }
69 |
70 | /// Starts observation until given owner is alive or `remove(observer:)` is called.
71 | ///
72 | /// - Requires: Given `observer` can be registered only once.
73 | ///
74 | /// - Attention:
75 | /// - After deallocation of owner `observer.update` will be never called.
76 | /// - Inside of `observer.update` closure you are alway on main thread.
77 | ///
78 | /// - Parameters:
79 | /// - owner: LifecycleOwner of newly created observation.
80 | /// - observer: Observer that is updated on every `data` change.
81 | func observe(owner: LifecycleOwner, observer: Observer) {
82 | let wrapper = LifecycleBoundObserver(owner: owner, observer: observer)
83 | observe(wrapper)
84 | }
85 |
86 | /// Starts observation until `remove(observer:)` called.
87 | ///
88 | /// - Parameters:
89 | /// - onUpdate: Closure that is called on `data` change.
90 | /// - Inside of `onUpdate` closure you are alway on main thread.
91 | ///
92 | /// - Returns: Observer that represents update block.
93 | @discardableResult func observeForever(onUpdate: @escaping (DataType) -> Void) -> Observer {
94 | let wrapper = LifecycleBoundObserver(observer: Observer(update: onUpdate))
95 | return observe(wrapper)
96 | }
97 |
98 | /// Starts observation until `remove(observer:)` called.
99 | ///
100 | /// - Requires: Given `observer` can be registered only once.
101 | ///
102 | /// - Attention:
103 | /// - Inside of `observer.update` closure you are alway on main thread.
104 | ///
105 | /// - Parameters:
106 | /// - observer: Observer that is updated on every `data` change.
107 | func observeForever(observer: Observer) {
108 | let wrapper = LifecycleBoundObserver(observer: observer)
109 | observe(wrapper)
110 | }
111 |
112 | // MARK: - Remove
113 |
114 | /// Unregister given `observer` from observation.
115 | ///
116 | /// - Parameter observer: Observer that has to be removed
117 | /// - Returns: `True` if observer was unregistered or `false` if observer
118 | /// wasn't never registered.
119 | @discardableResult func remove(observer: Observer) -> Bool {
120 | func onMainQueue() -> Bool {
121 | let existingIdx = observers.firstIndex { (rhs) -> Bool in
122 | observer.hashValue == rhs.observer.hashValue
123 | }
124 | if let idx = existingIdx {
125 | observers.remove(at: idx)
126 | return true
127 | }
128 | return false
129 | }
130 | return Thread.isMainThread ? onMainQueue() : DispatchQueue.main.sync(execute: onMainQueue)
131 | }
132 | }
133 |
134 | // MARK: - Trigger
135 |
136 | public extension FutureEvent where DataType == Void {
137 | /// Triggers observers.
138 | func trigger() {
139 | triggerObservers(())
140 | }
141 | }
142 |
143 | public extension FutureEvent where DataType: Any {
144 | /// Triggers observers with given argument.
145 | ///
146 | /// - Parameters:
147 | /// - arg: Argument that is passed to observers.
148 | func trigger(_ arg: DataType) {
149 | triggerObservers(arg)
150 | }
151 | }
152 |
153 | private extension FutureEvent {
154 | @discardableResult func observe(_ wrapper: LifecycleBoundObserver) -> Observer {
155 | func onMainQueue() -> Observer {
156 | guard observers.contains(wrapper) == false else {
157 | fatalError("Unable to register same observer multiple time")
158 | }
159 | observers.insert(wrapper)
160 |
161 | // Removes observer on owner dealloc
162 | if let owner = wrapper.owner {
163 | onDealloc(of: owner) { [weak self, weak wrapper] in
164 | if let wrapper = wrapper {
165 | self?.remove(observer: wrapper.observer)
166 | }
167 | }
168 | }
169 |
170 | return wrapper.observer
171 | }
172 | return Thread.isMainThread ? onMainQueue() : DispatchQueue.main.sync(execute: onMainQueue)
173 | }
174 |
175 | func triggerObservers(_ arg: DataType) {
176 | func onMainQueue() {
177 | // Removes destroyed observers
178 | observers = observers.filter {
179 | $0.state != .destroyed
180 | }
181 | // Triggers all observers
182 | observers.forEach {
183 | $0.observer.update(arg)
184 | }
185 | }
186 | return Thread.isMainThread ? onMainQueue() : DispatchQueue.main.sync(execute: onMainQueue)
187 | }
188 | }
189 |
--------------------------------------------------------------------------------
/Configs/iOS/ETObserver.framework/Headers/ETObserver-Swift.h:
--------------------------------------------------------------------------------
1 | // Generated by Apple Swift version 4.0.3 (swiftlang-900.0.74.1 clang-900.0.39.2)
2 | #pragma clang diagnostic push
3 | #pragma clang diagnostic ignored "-Wgcc-compat"
4 |
5 | #if !defined(__has_include)
6 | # define __has_include(x) 0
7 | #endif
8 | #if !defined(__has_attribute)
9 | # define __has_attribute(x) 0
10 | #endif
11 | #if !defined(__has_feature)
12 | # define __has_feature(x) 0
13 | #endif
14 | #if !defined(__has_warning)
15 | # define __has_warning(x) 0
16 | #endif
17 |
18 | #if __has_attribute(external_source_symbol)
19 | # define SWIFT_STRINGIFY(str) #str
20 | # define SWIFT_MODULE_NAMESPACE_PUSH(module_name) _Pragma(SWIFT_STRINGIFY(clang attribute push(__attribute__((external_source_symbol(language="Swift", defined_in=module_name, generated_declaration))), apply_to=any(function, enum, objc_interface, objc_category, objc_protocol))))
21 | # define SWIFT_MODULE_NAMESPACE_POP _Pragma("clang attribute pop")
22 | #else
23 | # define SWIFT_MODULE_NAMESPACE_PUSH(module_name)
24 | # define SWIFT_MODULE_NAMESPACE_POP
25 | #endif
26 |
27 | #if __has_include()
28 | # include
29 | #endif
30 |
31 | #pragma clang diagnostic ignored "-Wauto-import"
32 | #include
33 | #include
34 | #include
35 | #include
36 |
37 | #if !defined(SWIFT_TYPEDEFS)
38 | # define SWIFT_TYPEDEFS 1
39 | # if __has_include()
40 | # include
41 | # elif !defined(__cplusplus) || __cplusplus < 201103L
42 | typedef uint_least16_t char16_t;
43 | typedef uint_least32_t char32_t;
44 | # endif
45 | typedef float swift_float2 __attribute__((__ext_vector_type__(2)));
46 | typedef float swift_float3 __attribute__((__ext_vector_type__(3)));
47 | typedef float swift_float4 __attribute__((__ext_vector_type__(4)));
48 | typedef double swift_double2 __attribute__((__ext_vector_type__(2)));
49 | typedef double swift_double3 __attribute__((__ext_vector_type__(3)));
50 | typedef double swift_double4 __attribute__((__ext_vector_type__(4)));
51 | typedef int swift_int2 __attribute__((__ext_vector_type__(2)));
52 | typedef int swift_int3 __attribute__((__ext_vector_type__(3)));
53 | typedef int swift_int4 __attribute__((__ext_vector_type__(4)));
54 | typedef unsigned int swift_uint2 __attribute__((__ext_vector_type__(2)));
55 | typedef unsigned int swift_uint3 __attribute__((__ext_vector_type__(3)));
56 | typedef unsigned int swift_uint4 __attribute__((__ext_vector_type__(4)));
57 | #endif
58 |
59 | #if !defined(SWIFT_PASTE)
60 | # define SWIFT_PASTE_HELPER(x, y) x##y
61 | # define SWIFT_PASTE(x, y) SWIFT_PASTE_HELPER(x, y)
62 | #endif
63 | #if !defined(SWIFT_METATYPE)
64 | # define SWIFT_METATYPE(X) Class
65 | #endif
66 | #if !defined(SWIFT_CLASS_PROPERTY)
67 | # if __has_feature(objc_class_property)
68 | # define SWIFT_CLASS_PROPERTY(...) __VA_ARGS__
69 | # else
70 | # define SWIFT_CLASS_PROPERTY(...)
71 | # endif
72 | #endif
73 |
74 | #if __has_attribute(objc_runtime_name)
75 | # define SWIFT_RUNTIME_NAME(X) __attribute__((objc_runtime_name(X)))
76 | #else
77 | # define SWIFT_RUNTIME_NAME(X)
78 | #endif
79 | #if __has_attribute(swift_name)
80 | # define SWIFT_COMPILE_NAME(X) __attribute__((swift_name(X)))
81 | #else
82 | # define SWIFT_COMPILE_NAME(X)
83 | #endif
84 | #if __has_attribute(objc_method_family)
85 | # define SWIFT_METHOD_FAMILY(X) __attribute__((objc_method_family(X)))
86 | #else
87 | # define SWIFT_METHOD_FAMILY(X)
88 | #endif
89 | #if __has_attribute(noescape)
90 | # define SWIFT_NOESCAPE __attribute__((noescape))
91 | #else
92 | # define SWIFT_NOESCAPE
93 | #endif
94 | #if __has_attribute(warn_unused_result)
95 | # define SWIFT_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
96 | #else
97 | # define SWIFT_WARN_UNUSED_RESULT
98 | #endif
99 | #if __has_attribute(noreturn)
100 | # define SWIFT_NORETURN __attribute__((noreturn))
101 | #else
102 | # define SWIFT_NORETURN
103 | #endif
104 | #if !defined(SWIFT_CLASS_EXTRA)
105 | # define SWIFT_CLASS_EXTRA
106 | #endif
107 | #if !defined(SWIFT_PROTOCOL_EXTRA)
108 | # define SWIFT_PROTOCOL_EXTRA
109 | #endif
110 | #if !defined(SWIFT_ENUM_EXTRA)
111 | # define SWIFT_ENUM_EXTRA
112 | #endif
113 | #if !defined(SWIFT_CLASS)
114 | # if __has_attribute(objc_subclassing_restricted)
115 | # define SWIFT_CLASS(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) __attribute__((objc_subclassing_restricted)) SWIFT_CLASS_EXTRA
116 | # define SWIFT_CLASS_NAMED(SWIFT_NAME) __attribute__((objc_subclassing_restricted)) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
117 | # else
118 | # define SWIFT_CLASS(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
119 | # define SWIFT_CLASS_NAMED(SWIFT_NAME) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
120 | # endif
121 | #endif
122 |
123 | #if !defined(SWIFT_PROTOCOL)
124 | # define SWIFT_PROTOCOL(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) SWIFT_PROTOCOL_EXTRA
125 | # define SWIFT_PROTOCOL_NAMED(SWIFT_NAME) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_PROTOCOL_EXTRA
126 | #endif
127 |
128 | #if !defined(SWIFT_EXTENSION)
129 | # define SWIFT_EXTENSION(M) SWIFT_PASTE(M##_Swift_, __LINE__)
130 | #endif
131 |
132 | #if !defined(OBJC_DESIGNATED_INITIALIZER)
133 | # if __has_attribute(objc_designated_initializer)
134 | # define OBJC_DESIGNATED_INITIALIZER __attribute__((objc_designated_initializer))
135 | # else
136 | # define OBJC_DESIGNATED_INITIALIZER
137 | # endif
138 | #endif
139 | #if !defined(SWIFT_ENUM_ATTR)
140 | # if defined(__has_attribute) && __has_attribute(enum_extensibility)
141 | # define SWIFT_ENUM_ATTR __attribute__((enum_extensibility(open)))
142 | # else
143 | # define SWIFT_ENUM_ATTR
144 | # endif
145 | #endif
146 | #if !defined(SWIFT_ENUM)
147 | # define SWIFT_ENUM(_type, _name) enum _name : _type _name; enum SWIFT_ENUM_ATTR SWIFT_ENUM_EXTRA _name : _type
148 | # if __has_feature(generalized_swift_name)
149 | # define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME) enum _name : _type _name SWIFT_COMPILE_NAME(SWIFT_NAME); enum SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_ENUM_ATTR SWIFT_ENUM_EXTRA _name : _type
150 | # else
151 | # define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME) SWIFT_ENUM(_type, _name)
152 | # endif
153 | #endif
154 | #if !defined(SWIFT_UNAVAILABLE)
155 | # define SWIFT_UNAVAILABLE __attribute__((unavailable))
156 | #endif
157 | #if !defined(SWIFT_UNAVAILABLE_MSG)
158 | # define SWIFT_UNAVAILABLE_MSG(msg) __attribute__((unavailable(msg)))
159 | #endif
160 | #if !defined(SWIFT_AVAILABILITY)
161 | # define SWIFT_AVAILABILITY(plat, ...) __attribute__((availability(plat, __VA_ARGS__)))
162 | #endif
163 | #if !defined(SWIFT_DEPRECATED)
164 | # define SWIFT_DEPRECATED __attribute__((deprecated))
165 | #endif
166 | #if !defined(SWIFT_DEPRECATED_MSG)
167 | # define SWIFT_DEPRECATED_MSG(...) __attribute__((deprecated(__VA_ARGS__)))
168 | #endif
169 | #if __has_feature(attribute_diagnose_if_objc)
170 | # define SWIFT_DEPRECATED_OBJC(Msg) __attribute__((diagnose_if(1, Msg, "warning")))
171 | #else
172 | # define SWIFT_DEPRECATED_OBJC(Msg) SWIFT_DEPRECATED_MSG(Msg)
173 | #endif
174 | #if __has_feature(modules)
175 | #endif
176 |
177 | #pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
178 | #pragma clang diagnostic ignored "-Wduplicate-method-arg"
179 | #if __has_warning("-Wpragma-clang-attribute")
180 | # pragma clang diagnostic ignored "-Wpragma-clang-attribute"
181 | #endif
182 | #pragma clang diagnostic ignored "-Wunknown-pragmas"
183 | #pragma clang diagnostic ignored "-Wnullability"
184 |
185 | SWIFT_MODULE_NAMESPACE_PUSH("ETObserver")
186 | SWIFT_MODULE_NAMESPACE_POP
187 | #pragma clang diagnostic pop
188 |
--------------------------------------------------------------------------------
/docs/docsets/ETLiveData.docset/Contents/Resources/Documents/Functions.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Functions Reference
5 |
20 |
21 | ETLiveData Reference
22 |
25 |
27 |
72 |
73 |
74 |
75 | Functions
76 | The following functions are available globally.
77 |
78 |
79 |
80 |
81 |
82 |
83 |
90 |
91 |
92 |
93 |
94 |
95 |
Undocumented
96 |
97 |
99 |
Declaration
100 |
101 |
Swift
102 |
public func fatalError ( _ message : @autoclosure () -> String = "" , file : StaticString = #file , line : UInt = #line ) -> Never
103 |
104 |
105 |
107 |
109 |
110 |
117 |
118 |
119 |
120 |
121 |
122 |
This is a noreturn function that pauses forever
123 |
124 |
126 |
Declaration
127 |
128 |
Swift
129 |
public func unreachable () -> Never
130 |
131 |
132 |
134 |
136 |
137 |
139 |
140 |
144 |
145 |
Functions Reference
5 |
21 |
22 | ETBinding Reference
23 |
26 |
28 |
90 |
91 |
92 |
93 | Functions
94 | The following functions are available globally.
95 |
96 |
97 |
98 |
99 |
100 |
101 |
108 |
109 |
110 |
111 |
112 |
113 |
Executes action upon deallocation of owner
114 |
115 |
117 |
Declaration
118 |
119 |
Swift
120 |
public func onDealloc ( of owner : Any , closure : @escaping () -> Void )
121 |
122 |
123 |
125 |
Parameters
126 |
127 |
128 |
129 |
130 |
131 | owner
132 |
133 |
134 |
135 |
136 |
Owner to track.
137 |
139 |
140 |
141 |
142 |
143 | closure
144 |
145 |
146 |
147 |
148 |
Closure to execute.
149 |
151 |
152 |
153 |
154 |
156 |
158 |
159 |
161 |
162 |
166 |
167 |
Functions Reference
5 |
21 |
22 | ETBinding Reference
23 |
26 |
28 |
90 |
91 |
92 |
93 | Functions
94 | The following functions are available globally.
95 |
96 |
97 |
98 |
99 |
100 |
101 |
108 |
109 |
110 |
111 |
112 |
113 |
Executes action upon deallocation of owner
114 |
115 |
117 |
Declaration
118 |
119 |
Swift
120 |
public func onDealloc ( of owner : Any , closure : @escaping () -> Void )
121 |
122 |
123 |
125 |
Parameters
126 |
127 |
128 |
129 |
130 |
131 | owner
132 |
133 |
134 |
135 |
136 |
Owner to track.
137 |
139 |
140 |
141 |
142 |
143 | closure
144 |
145 |
146 |
147 |
148 |
Closure to execute.
149 |
151 |
152 |
153 |
154 |
156 |
158 |
159 |
161 |
162 |
166 |
167 |
Enumerations Reference
5 |
21 |
22 | ETBinding Reference
23 |
26 |
28 |
90 |
91 |
92 |
93 | Enumerations
94 | The following enumerations are available globally.
95 |
96 |
97 |
98 |
99 |
100 |
101 |
108 |
109 |
110 |
111 |
112 |
113 |
Value with state added
114 |
115 |
See more
116 |
118 |
Declaration
119 |
120 |
Swift
121 |
public enum StateValue < Value >
122 |
123 |
124 |
126 |
128 |
129 |
131 |
132 |
133 |
140 |
141 |
142 |
143 |
144 |
149 |
150 |
Declaration
151 |
152 |
Swift
153 |
public enum LifecycleState
154 |
155 |
156 |
158 |
160 |
161 |
163 |
164 |
168 |
169 |
Protocols Reference
5 |
21 |
22 | ETBinding Reference
23 |
26 |
28 |
90 |
91 |
92 |
93 | Protocols
94 | The following protocols are available globally.
95 |
96 |
97 |
98 |
99 |
100 |
101 |
108 |
109 |
110 |
111 |
112 |
113 |
Declares methods for observation.
114 |
115 |
See more
116 |
118 |
Declaration
119 |
120 |
Swift
121 |
public protocol Observable : AnyObject
122 |
123 |
124 |
126 |
128 |
129 |
131 |
132 |
133 |
140 |
141 |
142 |
143 |
144 |
145 |
Declares methods for observation.
146 |
147 |
See more
148 |
150 |
Declaration
151 |
152 |
Swift
153 |
public protocol SingleEventObservable : AnyObject
154 |
155 |
156 |
158 |
160 |
161 |
163 |
164 |
168 |
169 |
FatalErrorUtil Structure Reference
5 |
21 |
22 | ETLiveData Reference
23 |
26 |
28 |
73 |
74 |
75 |
76 | FatalErrorUtil
77 |
78 |
79 |
public struct FatalErrorUtil
80 |
81 |
82 |
Utility functions that can replace and restore the fatalError global function.
84 |
85 |
86 |
87 |
88 |
89 |
90 |
97 |
98 |
99 |
100 |
101 |
102 |
Replace the fatalError global function with something else.
103 |
104 |
106 |
Declaration
107 |
108 |
Swift
109 |
public static func replaceFatalError ( closure : @escaping ( String , StaticString , UInt ) -> Never )
110 |
111 |
112 |
114 |
116 |
117 |
124 |
125 |
126 |
127 |
128 |
129 |
Restore the fatalError global function back to the original Swift implementation
130 |
131 |
133 |
Declaration
134 |
135 |
Swift
136 |
public static func restoreFatalError ()
137 |
138 |
139 |
141 |
143 |
144 |
146 |
147 |
151 |
152 |
Enumerations Reference
5 |
21 |
22 | ETBinding Reference
23 |
26 |
28 |
90 |
91 |
92 |
93 | Enumerations
94 | The following enumerations are available globally.
95 |
96 |
97 |
98 |
99 |
100 |
101 |
108 |
109 |
110 |
111 |
112 |
113 |
Value with state added
114 |
115 |
See more
116 |
118 |
Declaration
119 |
120 |
Swift
121 |
public enum StateValue < Value >
122 |
123 |
124 |
126 |
128 |
129 |
131 |
132 |
133 |
140 |
141 |
142 |
143 |
144 |
149 |
150 |
Declaration
151 |
152 |
Swift
153 |
public enum LifecycleState
154 |
155 |
156 |
158 |
160 |
161 |
163 |
164 |
168 |
169 |
Protocols Reference
5 |
21 |
22 | ETBinding Reference
23 |
26 |
28 |
90 |
91 |
92 |
93 | Protocols
94 | The following protocols are available globally.
95 |
96 |
97 |
98 |
99 |
100 |
101 |
108 |
109 |
110 |
111 |
112 |
113 |
Declares methods for observation.
114 |
115 |
See more
116 |
118 |
Declaration
119 |
120 |
Swift
121 |
public protocol Observable : AnyObject
122 |
123 |
124 |
126 |
128 |
129 |
131 |
132 |
133 |
140 |
141 |
142 |
143 |
144 |
145 |
Declares methods for observation.
146 |
147 |
See more
148 |
150 |
Declaration
151 |
152 |
Swift
153 |
public protocol SingleEventObservable : AnyObject
154 |
155 |
156 |
158 |
160 |
161 |
163 |
164 |
168 |
169 |
FatalErrorUtil Structure Reference
5 |
21 |
22 | ETLiveData Reference
23 |
26 |
28 |
73 |
74 |
75 |
76 | FatalErrorUtil
77 |
78 |
79 |
public struct FatalErrorUtil
80 |
81 |
82 |
Utility functions that can replace and restore the fatalError global function.
84 |
85 |
86 |
87 |
88 |
89 |
90 |
97 |
98 |
99 |
100 |
101 |
102 |
Replace the fatalError global function with something else.
103 |
104 |
106 |
Declaration
107 |
108 |
Swift
109 |
public static func replaceFatalError ( closure : @escaping ( String , StaticString , UInt ) -> Never )
110 |
111 |
112 |
114 |
116 |
117 |
124 |
125 |
126 |
127 |
128 |
129 |
Restore the fatalError global function back to the original Swift implementation
130 |
131 |
133 |
Declaration
134 |
135 |
Swift
136 |
public static func restoreFatalError ()
137 |
138 |
139 |
141 |
143 |
144 |
146 |
147 |
151 |
152 |
23 | Structures Reference
24 | 
24 | LifecycleState Enumeration Reference
25 |