EntityStream
open class EntityStream : ObjectBase
A stream of entity values.
-
Close this stream and release all associated resources, without checking first that the end of stream has been reached.
See also
close
.Declaration
Swift
open func abort() throws
-
Close this stream and release all associated resources, checking first that the end of stream has been reached. Can safely be called even if the stream was previously closed. If a delta link was encountered before the stream was closed, it will be available via the
deltaLink
property only after the stream is closed. If a next link was encountered before the stream was closed, it will be available via thenextLink
property only after the stream is closed.See also
abort
.Declaration
Swift
open func close() throws
-
The delta-link (if any) that was encountered when
next
was called repeatedly until end of stream and thenclose
was called, otherwisenil
.Declaration
Swift
open var deltaLink: String? { get }
-
Declaration
Swift
open func hasNext() throws -> Bool
Return Value
True If this stream has not been
close
and has a next entity value. Otherwise returnfalse
. -
Has
close
been called?Declaration
Swift
open var isClosed: Bool { get }
-
Declaration
Swift
open func next() throws -> EntityValue
Return Value
The next entity value in this stream. Only call this if a previous call to
hasNext
returnedtrue
. -
The next-link (if any) that was encountered when
next
was called repeatedly until end of stream and thenclose
was called, otherwisenil
.Declaration
Swift
open var nextLink: String? { get }
-
The read-link (if any) that was encountered when
next
was called repeatedly until end of stream and thenclose
was called, otherwisenil
.Declaration
Swift
open var readLink: String? { get }