Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 739 Bytes

teardown.md

File metadata and controls

46 lines (34 loc) · 739 Bytes

[Teardown API](@id teardown_api)

Any subscription-like object should implement a valid teardown logic.

Example

using Rocket

struct MuCustomSubscription <: Teardown
    # some fields here
end

Rocket.as_teardown(::Type{<:MuCustomSubscription}) = UnsubscribableTeardownLogic()

function on_unsubscribe!(subscription::MyCustomSubscription)
    # dispose resources here
end

Traits

TeardownLogic
as_teardown
UnsubscribableTeardownLogic
on_unsubscribe!
CallableTeardownLogic
VoidTeardownLogic
InvalidTeardownLogic

Types

Teardown
unsubscribe!

Errors

InvalidTeardownLogicTraitUsageError
InvalidMultipleTeardownLogicTraitUsageError
MissingOnUnsubscribeImplementationError