Code location

  • Source: rust/src/
  • Tests: rust/tests/

Common commands

  • Build: bazel build //rust/...
  • Repin crates: CARGO_BAZEL_REPIN=true bazel run @crates//:all

Testing

See rust/TESTING.md

Code conventions

Logging

use log::{warn, info, debug};

warn!("actionable: something needs attention");
info!("useful: browser resolved successfully");
debug!("diagnostic: request details for debugging");

Deprecation

#[deprecated(since = "0.1.0", note = "Use new_function instead")]
pub fn old_function() { }

Documentation

Use doc comments for public APIs:

/// Brief description.
///
/// # Arguments
/// * `name` - description
///
/// # Returns
/// Description of return value.
///
/// # Errors
/// Returns `ErrorType` when condition.