Struct Searcher

pub struct Searcher { /* private fields */ }

Searcher to search cubes.

Implementations

impl Searcher

pub fn new() -> Self

Creates a new searcher instance.

The default search timeout is 3 seconds. Use [Searcher::new_with_timeout][] to specify custom timeout.

pub async fn all(&mut self) -> Result<Vec<Cube>>

Searches for all cubes.

This searches for cubes for 3 seconds. Use Searcher::all_timeout to use custom timeout.

pub async fn nearest(&mut self) -> Result<Cube>

Finds the nearest cube.

This searches for cubes for 3 seconds. Use Searcher::nearest_timeout to use custom timeout.

pub async fn all_timeout(&mut self, timeout: Duration) -> Result<Vec<Cube>>

Searches for all cubes with custom timeout.

Cubes are sorted from nearest to farest.

use std::time::Duration;
use toio::Cube;

#[tokio::main]
async fn main() {
    let cubes = Cube::search().all_timeout(Duration::from_secs(8)).await.unwrap();
}

pub async fn nearest_timeout(&mut self, timeout: Duration) -> Result<Cube>

Finds the nearest cube with custom timeout.

use std::time::Duration;
use toio::Cube;

#[tokio::main]
async fn main() {
    let cube = Cube::search().nearest_timeout(Duration::from_secs(8)).await.unwrap();
}

Trait Implementations

impl Debug for Searcher

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

Formats the value using the given formatter.