Struct RateLimit 

pub struct RateLimit { /* private fields */ }

A rate limit: when it resets and, if known, how much of the quota is left.

use std::time::Duration;
use rich::Console;
use rich_ext::countdown::RateLimit;

let limit = RateLimit::new(Duration::from_secs(42)).limit(100).remaining(0).scope("search API");
let out = Console::builder().width(80).build().render_to_string(&limit);
assert_eq!(out, "⚠ warning rate limited (search API) — resets in 0:00:42 (0/100 left)");

Implementations

impl RateLimit

pub fn new(resets_in: Duration) -> Self

Limited until resets_in from now.

pub fn limit(self, limit: u64) -> Self

The quota per window.

pub fn remaining(self, remaining: u64) -> Self

How much of the quota is left.

pub fn scope(self, scope: impl Into<String>) -> Self

What is limited, e.g. an API name.

pub fn bar(self, window: Duration) -> Self

Also draw a CountdownBar over a reset window of window.

pub fn bar_width(self, width: usize) -> Self

The bar’s width in cells (default 20).

pub fn symbols(self, set: SymbolSet) -> Self

How the status is marked (default Unicode; ASCII on an ASCII-only console).

pub fn at(&self, left: Duration) -> Self

The same limit with left until the reset: the frame for one tick.

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RateLimit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for RateLimit

impl PartialEq for RateLimit

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Renderable for RateLimit

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn measure(&self, _console: &Console, options: &ConsoleOptions) -> Measurement

The (minimum, maximum) cell width this renderable wants. Port of __rich_measure__. The default is what upstream’s Measurement.get returns for a renderable without one: anything from nothing to the whole width, (0, max_width).

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.

fn print_end_line(&self, _options: &ConsoleOptions) -> bool

Whether a top-level print ends this renderable’s last line. This port’s renderables separate lines, where upstream’s end each line with "\n", so a print adds the final line break. A renderable whose upstream output stops without one (Screen, LiveRender, a Rule whose end has no newline) returns false, and the next output continues its last line. options are the print’s options.

impl StructuralPartialEq for RateLimit