Struct warp_ratelimit::DistinctVisitor

pub struct DistinctVisitor {
    pub first_request_time: Instant,
    pub num_requests: u64,
    pub ip: IpAddr,
}

A single distinct visitor for the filter to keep track of.

Example

use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use std::sync::{Arc, Mutex};
use std::time::Duration;

#[tokio::main]
async fn main() {
    // Memory for filter
    let mem = Arc::new(Mutex::new(Vec::new()));
    // Ratelimiting filter that lets in 10 requests from each user every 6 minutes
    let filter = warp_ratelimit::ratelimit_filter(Arc::clone(&mem), 10, Duration::new(360, 0)).await;
    warp::test::request()
        .remote_addr(SocketAddr::new(IpAddr::V4(Ipv4Addr::new(1, 1, 1, 1)), 8080))
        .reply(&filter)
        .await;
    // Memory should contain single visitor
    let mem_lock = mem.lock().unwrap();
    assert_eq!((*mem_lock).len(), 1);
    let first_elem = (*mem_lock)[0].clone();
    assert_eq!(first_elem.ip, Ipv4Addr::new(1, 1, 1, 1));
    assert_eq!(first_elem.num_requests, 1);
}

Fields

first_request_time: Instant

num_requests: u64

ip: IpAddr

Trait Implementations

impl Clone for DistinctVisitor

fn clone(&self) -> DistinctVisitor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DistinctVisitor

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

Formats the value using the given formatter.

impl Eq for DistinctVisitor

impl PartialEq<DistinctVisitor> for DistinctVisitor

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for DistinctVisitor

impl StructuralPartialEq for DistinctVisitor