aoc_leaderbot_slack_lib 0.3.0

Slack-specific support library for aoc_leaderbot, an Advent of Code leaderboard-watching bot
docs.rs failed to build aoc_leaderbot_slack_lib-0.3.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

aoc_leaderbot_slack_lib

CI codecov Security audit crates.io MSRV downloads docs.rs Contributor Covenant

Library implementing Slack-specific helpers for aoc_leaderbot, a bot that can watch an Advent of Code private leaderboard for changes and report them to various channels like Slack.

Installing

Add aoc_leaderbot_slack_lib to your dependencies:

[dependencies]

aoc_leaderbot_slack_lib = "0.3.0"

or by running:

cargo add aoc_leaderbot_slack_lib

Trait implementations

This library includes implementations of the traits found in aoc_leaderbot_lib.

SlackWebhookReporter

Required feature: reporter-webhook (enabled by default)

An implementation of the Reporter trait that reports changes to the leaderboard to a Slack channel via a Slack webhook.

The reporter has several configurable input properties. Although most have default values, at least two must be specified explicitly:

  • webhook_url: URL of the Slack webhook to use to report changes.
  • channel: Slack channel where to post message reporting changes.

There are other optional properties that can be specified. The easiest way to create a reporter instance would be via the builder. Many properties will also default to reading their values from environment variables (see each property's documentation for details).

Minimum Rust version

aoc_leaderbot_slack_lib currently builds on Rust 1.88 or newer.

Contributing / Local development

For information about contributing to this project, see CONTRIBUTING. For information regarding local development, see DEVELOPMENT.