Skip to content

Commit

Permalink
Added documentation for Supervisor and SupervisorRef's "is_system_sup…
Browse files Browse the repository at this point in the history
…ervisor".
  • Loading branch information
r3v2d0g committed Nov 11, 2019
1 parent 587998a commit 63babc6
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions bastion/src/supervisor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ pub struct Supervisor {
// supervision strategy is not "one-for-one".
stopped: FxHashMap<BastionId, Supervised>,
strategy: SupervisionStrategy,
// TODO: doc
// Whether this supervisor was started by the system (in
// which case, users shouldn't be able to get a reference
// to it).
is_system_supervisor: bool,
// Messages that were received before the supervisor was
// started. Those will be "replayed" once a start message
Expand All @@ -74,7 +76,9 @@ pub struct Supervisor {
pub struct SupervisorRef {
id: BastionId,
sender: Sender,
// TODO: doc
// Whether the supervisor referenced was started by
// the system (in which case, users shouldn't be able
// to get a reference to it).
is_system_supervisor: bool,
}

Expand Down

0 comments on commit 63babc6

Please sign in to comment.