Struct redis::geo::RadiusOptions[][src]

pub struct RadiusOptions { /* fields omitted */ }
This is supported on crate feature geospatial only.

Options for the GEORADIUS and GEORADIUSBYMEMBER commands

Example

use redis::{Commands, RedisResult};
use redis::geo::{RadiusSearchResult, RadiusOptions, RadiusOrder, Unit};
fn nearest_in_radius(
    con: &mut redis::Connection,
    key: &str,
    longitude: f64,
    latitude: f64,
    meters: f64,
    limit: usize,
) -> RedisResult<Vec<RadiusSearchResult>> {
    let opts = RadiusOptions::default()
        .order(RadiusOrder::Asc)
        .limit(limit);
    con.geo_radius(key, longitude, latitude, meters, Unit::Meters, opts)
}

Implementations

impl RadiusOptions[src]

pub fn limit(self, n: usize) -> Self[src]

Limit the results to the first N matching items.

pub fn with_dist(self) -> Self[src]

Return the distance of the returned items from the specified center. The distance is returned in the same unit as the unit specified as the radius argument of the command.

pub fn with_coord(self) -> Self[src]

Return the longitude, latitude coordinates of the matching items.

pub fn order(self, o: RadiusOrder) -> Self[src]

Sort the returned items

pub fn store<K: ToRedisArgs>(self, key: K) -> Self[src]

Store the results in a sorted set at key, instead of returning them.

This feature can't be used with any with_* method.

pub fn store_dist<K: ToRedisArgs>(self, key: K) -> Self[src]

Store the results in a sorted set at key, with the distance from the center as its score. This feature can't be used with any with_* method.

Trait Implementations

impl Default for RadiusOptions[src]

impl ToRedisArgs for RadiusOptions[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,