AsyncExpectation

public struct AsyncExpectation<Value> : Expectation

Undocumented


                    
                    
                    expression

Undocumented

Declaration

Swift

public let expression: AsyncExpression<Value>

status
The status of the test after matchers have been evaluated.

This property can be used for changing test behavior based whether an expectation has passed.

In the below example, we perform additional tests on an array only if it has enough elements.
```
if expect(array).to(haveCount(10)).status == .passed {
   expect(array[9]).to(...)
}
```
Remark
Similar functionality can be achieved using the onFailure(throw:) method.
Declaration
Swift

public let status: ExpectationStatus


                    
                    
                    init(expression:)

Undocumented

Declaration

Swift

public init(expression: AsyncExpression<Value>)


                    
                    
                    location

Undocumented

Declaration

Swift

public var location: SourceLocation { get }

verify(_:_:)
Takes the result of a test and passes it to the assertion handler.
Declaration
Swift

@discardableResult public func verify(_ pass: Bool, _ message: FailureMessage) -> AsyncExpectation<Value>
Return Value

An updated Expression with the result of the test applied to the status property.


                    
                    
                    to(_:description:)

Asynchronous

Tests the actual value using a matcher to match.

Declaration

Swift

@discardableResult
public func to(_ matcher: Matcher<Value>, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toNot(_:description:)

Asynchronous

Tests the actual value using a matcher to not match.

Declaration

Swift

@discardableResult
public func toNot(_ matcher: Matcher<Value>, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    notTo(_:description:)

Asynchronous

Tests the actual value using a matcher to not match.

Alias to toNot().

Declaration

Swift

@discardableResult
public func notTo(_ matcher: Matcher<Value>, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    to(_:description:)

Asynchronous

Tests the actual value using a matcher to match.

Declaration

Swift

@discardableResult
public func to(_ matcher: AsyncMatcher<Value>, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toNot(_:description:)

Asynchronous

Tests the actual value using a matcher to not match.

Declaration

Swift

@discardableResult
public func toNot(_ matcher: AsyncMatcher<Value>, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    notTo(_:description:)

Asynchronous

Tests the actual value using a matcher to not match.

Alias to toNot().

Declaration

Swift

@discardableResult
public func notTo(_ matcher: AsyncMatcher<Value>, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    ==(_:_:)

Asynchronous

Undocumented

Declaration

Swift

public static func == (lhs: AsyncExpectation, rhs: ExpectationNil) async


                    
                    
                    !=(_:_:)

Asynchronous

Undocumented

Declaration

Swift

public static func != (lhs: AsyncExpectation, rhs: ExpectationNil) async

With Synchronous Matchers


                    
                    
                    toEventually(_:timeout:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to match by checking continuously at each pollInterval until the timeout is reached.

Declaration

Swift

@discardableResult
public func toEventually(_ matcher: Matcher<Value>, timeout: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toEventuallyNot(_:timeout:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to not match by checking continuously at each pollInterval until the timeout is reached.

Declaration

Swift

@discardableResult
public func toEventuallyNot(_ matcher: Matcher<Value>, timeout: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toNotEventually(_:timeout:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to not match by checking continuously at each pollInterval until the timeout is reached.

Alias of toEventuallyNot()

Declaration

Swift

@discardableResult
public func toNotEventually(_ matcher: Matcher<Value>, timeout: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toNever(_:until:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to never match by checking continuously at each pollInterval until the timeout is reached.

Declaration

Swift

@discardableResult
public func toNever(_ matcher: Matcher<Value>, until: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    neverTo(_:until:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to never match by checking continuously at each pollInterval until the timeout is reached.

Alias of toNever()

Declaration

Swift

@discardableResult
public func neverTo(_ matcher: Matcher<Value>, until: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toAlways(_:until:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to always match by checking continusouly at each pollInterval until the timeout is reached

Declaration

Swift

@discardableResult
public func toAlways(_ matcher: Matcher<Value>, until: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    alwaysTo(_:until:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to always match by checking continusouly at each pollInterval until the timeout is reached

Alias of toAlways()

Declaration

Swift

@discardableResult
public func alwaysTo(_ matcher: Matcher<Value>, until: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>

With AsyncMatchers


                    
                    
                    toEventually(_:timeout:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to match by checking continuously at each pollInterval until the timeout is reached.

Declaration

Swift

@discardableResult
public func toEventually(_ matcher: AsyncMatcher<Value>, timeout: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toEventuallyNot(_:timeout:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to not match by checking continuously at each pollInterval until the timeout is reached.

Declaration

Swift

@discardableResult
public func toEventuallyNot(_ matcher: AsyncMatcher<Value>, timeout: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toNotEventually(_:timeout:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to not match by checking continuously at each pollInterval until the timeout is reached.

Alias of toEventuallyNot()

Declaration

Swift

@discardableResult
public func toNotEventually(_ matcher: AsyncMatcher<Value>, timeout: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toNever(_:until:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to never match by checking continuously at each pollInterval until the timeout is reached.

Declaration

Swift

@discardableResult
public func toNever(_ matcher: AsyncMatcher<Value>, until: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    neverTo(_:until:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to never match by checking continuously at each pollInterval until the timeout is reached.

Alias of toNever()

Declaration

Swift

@discardableResult
public func neverTo(_ matcher: AsyncMatcher<Value>, until: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    toAlways(_:until:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to always match by checking continusouly at each pollInterval until the timeout is reached

Declaration

Swift

@discardableResult
public func toAlways(_ matcher: AsyncMatcher<Value>, until: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>


                    
                    
                    alwaysTo(_:until:pollInterval:description:)

Asynchronous

Tests the actual value using a matcher to always match by checking continusouly at each pollInterval until the timeout is reached

Alias of toAlways()

Declaration

Swift

@discardableResult
public func alwaysTo(_ matcher: AsyncMatcher<Value>, until: NimbleTimeInterval = PollingDefaults.timeout, pollInterval: NimbleTimeInterval = PollingDefaults.pollInterval, description: String? = nil) async -> AsyncExpectation<Value>

AsyncExpectation

Declaration

Declaration

Declaration

Declaration

Declaration

Return Value

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

With Synchronous Matchers

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

With AsyncMatchers

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration