Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sync: doc of watch::Sender::send improved #4959

Merged
merged 4 commits into from Sep 1, 2022

Commits on Aug 30, 2022

  1. sync: doc of watch::Sender::send improved

    Current documentation of `sync::watch::Sender::send` may be intepreted
    as the method failing if at some point in past the channel has been
    closed because every receiver has been dropped. This isn't true,
    however, as the channel could have been reopened by using
    `sync::watch::Sender::subscribe`.
    
    This fix clarifies the behavior. Moreover, it is noted that on failure,
    the value isn't made available to future subscribers (but returned as
    part of the `SendError`).
    
    Fixes tokio-rs#4957.
    JanBeh committed Aug 30, 2022
    Copy the full SHA
    d2bd60b View commit details
    Browse the repository at this point in the history
  2. amend! sync: doc of watch::Sender::send improved

    sync: doc of watch::Sender::send improved
    
    Current documentation of `sync::watch::Sender::send` may be intepreted
    as the method failing if at some point in past the channel has been
    closed because every receiver has been dropped. This isn't true,
    however, as the channel could have been reopened by using
    `sync::watch::Sender::subscribe`.
    
    This fix clarifies the behavior. Moreover, it is noted that on failure,
    the value isn't made available to future subscribers (but returned as
    part of the `SendError`), and that the other send methods
    (`send_if_modified`, `send_modify`, or `send_replace`) can be used to
    always make a new value available for future receivers, even if no
    receiver currently exists.
    
    Fixes tokio-rs#4957.
    JanBeh committed Aug 30, 2022
    Copy the full SHA
    da8b888 View commit details
    Browse the repository at this point in the history
  3. Copy the full SHA
    202db6e View commit details
    Browse the repository at this point in the history

Commits on Sep 1, 2022

  1. Copy the full SHA
    47a60f4 View commit details
    Browse the repository at this point in the history