Back to Rxswift

DisposeBag

docs/Classes/DisposeBag.html

6.10.22.5 KB
Original Source

DisposeBag

public final class DisposeBag : DisposeBase

Thread safe bag that disposes added disposables on deinit.

This returns ARC (RAII) like resource management to RxSwift.

In case contained disposables need to be disposed, just put a different dispose bag or create a new one in its place.

self.existingDisposeBag = DisposeBag()

In case explicit disposal is necessary, there is also CompositeDisposable.

`

                init()
                `

Constructs new empty dispose bag.

Declaration

Swift

override public init()

`

                insert(_:)
                `

Adds disposable to be disposed when dispose bag is being deinited.

Declaration

Swift

public func insert(_ disposable: Disposable)

Parameters

| disposable |

Disposable to add.

|

`

                init(disposing:)
                `

Convenience init allows a list of disposables to be gathered for disposal.

Declaration

Swift

convenience init(disposing disposables: Disposable...)

`

                init(builder:)
                `

Convenience init which utilizes a function builder to let you pass in a list of disposables to make a DisposeBag of.

Declaration

Swift

convenience init(@DisposeBag.DisposableBuilder builder: () -> [Disposable])

`

                init(disposing:)
                `

Convenience init allows an array of disposables to be gathered for disposal.

Declaration

Swift

convenience init(disposing disposables: [Disposable])

`

                insert(_:)
                `

Convenience function allows a list of disposables to be gathered for disposal.

Declaration

Swift

func insert(_ disposables: Disposable...)

`

                insert(builder:)
                `

Convenience function allows a list of disposables to be gathered for disposal.

Declaration

Swift

func insert(@DisposeBag.DisposableBuilder builder: () -> [Disposable])

`

                insert(_:)
                `

Convenience function allows an array of disposables to be gathered for disposal.

Declaration

Swift

func insert(_ disposables: [Disposable])

`

                DisposableBuilder
                `

Undocumented

See more

Declaration

Swift

@resultBuilder
struct DisposableBuilder