Struct tbot::types::location::Live

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

Information about a live location.

Fields (Non-exhaustive)§

This struct is marked as 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§

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.

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.

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§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method tests for self and other values to be equal, and is used by ==.
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more