Struct twitter_stream::builder::BoundingBox

#[repr(C)]pub struct BoundingBox {
    pub west_longitude: f64,
    pub south_latitude: f64,
    pub east_longitude: f64,
    pub north_latitude: f64,
}

A BoundingBox is a rectangular area on the globe specified by coordinates of the southwest and northeast edges in decimal degrees.

Fields

west_longitude: f64

Longitude of the west side of the bounding box.

south_latitude: f64

Latitude of the south side of the bounding box.

east_longitude: f64

Longitude of the east side of the bounding box.

north_latitude: f64

Latitude of the north side of the bounding box.

Implementations

impl BoundingBox

pub const fn new(
    west_longitude: f64,
    south_latitude: f64,
    east_longitude: f64,
    north_latitude: f64
) -> Self

Creates a BoundingBox with the longitudes and latitudes of its sides.

Example

use twitter_stream::builder::BoundingBox;

// Examples taken from Twitter's documentation.
BoundingBox::new(-122.75, 36.8, -121.75, 37.8); // San Francisco
BoundingBox::new(-74.0, 40.0, -73.0, 41.0); // New York City

pub fn unflatten_slice(slice: &[[f64; 4]]) -> &[Self]

Creates a slice of BoundingBox-es from a slice of arrays of [west_longitude, south_latitude, east_longitude, north_latitude].

Examples

use twitter_stream::builder::BoundingBox;

#[derive(serde::Deserialize)]
struct Config {
    locations: Vec<[f64; 4]>,
}

let config = r#"{"locations": [[-122.75, 36.8, -121.75, 37.8]]}"#;
let config: Config = serde_json::from_str(config).unwrap();

let locations = BoundingBox::unflatten_slice(&config.locations);
assert_eq!(locations, [BoundingBox::new(-122.75, 36.8, -121.75, 37.8)]);

pub fn flatten_slice(bboxes: &[Self]) -> &[[f64; 4]]

Converts a slice of BoundingBox-es into a slice of arrays of [west_longitude, south_latitude, east_longitude, north_latitude].

pub fn unflatten_vec(vec: Vec<[f64; 4]>) -> Vec<Self>

Creates a vector of BoundingBox-es from a vector of arrays of [west_longitude, south_latitude, east_longitude, north_latitude].

Examples

use twitter_stream::builder::BoundingBox;

#[derive(serde::Deserialize)]
struct Config {
    locations: Vec<[f64; 4]>,
}

let config = r#"{"locations": [[-122.75, 36.8, -121.75, 37.8]]}"#;
let config: Config = serde_json::from_str(config).unwrap();

let locations = BoundingBox::unflatten_vec(config.locations);
assert_eq!(locations, [BoundingBox::new(-122.75, 36.8, -121.75, 37.8)]);

pub fn flatten_vec(vec: Vec<Self>) -> Vec<[f64; 4]>

Converts a vector of BoundingBox-es into a vector of arrays of [west_longitude, south_latitude, east_longitude, north_latitude].

Trait Implementations

impl AsRef<[f64; 4]> for BoundingBox

pub fn as_ref(&self) -> &[f64; 4]

Performs the conversion.

impl Clone for BoundingBox

pub fn clone(&self) -> BoundingBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BoundingBox

impl Debug for BoundingBox

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

Formats the value using the given formatter.

impl From<[f64; 4]> for BoundingBox

pub fn from(
    [west_longitude, south_latitude, east_longitude, north_latitude]: [f64; 4]
) -> Self

Performs the conversion.

impl From<((f64, f64), (f64, f64))> for BoundingBox

pub fn from(
    ((west_longitude, south_latitude), (east_longitude, north_latitude)): ((f64, f64), (f64, f64))
) -> Self

Creates a BoundingBox with two (longitude, latitude) pairs.

The first argument specifies the southwest edge and the latter specifies the northeast edge.

impl From<(f64, f64, f64, f64)> for BoundingBox

pub fn from(
    (west_longitude, south_latitude, east_longitude, north_latitude): (f64, f64, f64, f64)
) -> Self

Performs the conversion.

impl PartialEq<BoundingBox> for BoundingBox

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

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

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

This method tests for !=.

impl StructuralPartialEq for BoundingBox