Struct tbot::types::location::Live

#[non_exhaustive]
pub struct Live {
    pub live_period: u32,
    pub heading: Option<u16>,
    pub proximity_alert_radius: Option<u32>,
}

Information about a live location.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

live_period: u32

Time relative to the message sending date, during which the location can be updated, in seconds. For active live locations only.

heading: Option<u16>

The direction in which user is moving, in degrees and in range 1..=360. For active live locations only.

proximity_alert_radius: Option<u32>

Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.

Implementations

impl Live

pub fn new(live_period: u32) -> Self

Creates a new live location. The live_period must be in range 60..=86_400; it reflects the live_period parameter.

Panics

Panics if the duration is not in range 60..=86_400.

pub fn heading(self, heading: u16) -> Self

Configures the direction in which the user is headed. The value must be in range 1..=360. Reflects the heading parameter.

Panics

Panics if heading is not in range 1..=360.

pub fn proximity_alert_radius(self, radius: u32) -> Self

Configures the maximum distance for proximity alerts about a user approaching another, in meters. The value must be in range 1..=100_000. Reflects the proximity_alert_radius paramter.

Panics

Panics if the value is not in range 1..=100_000.

Trait Implementations

impl Clone for Live

fn clone(&self) -> Live

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Live

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Live

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Live

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Live> for Live

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Live

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Live

impl Eq for Live

impl StructuralEq for Live

impl StructuralPartialEq for Live