Skip to main content

PeerId

Struct PeerId 

Source
pub struct PeerId(/* private fields */);
Expand description

A compact peer identifier.

use std::mem::size_of;
assert_eq!(size_of::<grammers_session::types::PeerId>(), size_of::<i64>());

The PeerInfo cached by the session for this PeerId may be retrieved via crate::Session::peer.

The internal representation uses the Bot API Dialog ID format to bit-pack both the peer’s true identifier and type in a single integer.

Internally, arbitrary values outside the valid range of Bot API Dialog ID may be used to represent special peer identifiers.

Implementations§

Source§

impl PeerId

Source

pub fn self_user() -> Self

Creates a peer identity for the currently-logged-in user or bot account.

Internally, this will use a special sentinel value outside of any valid Bot API Dialog ID range.

Source

pub fn user(id: i64) -> Option<Self>

Creates a peer identity for a user or bot account.

Source

pub fn chat(id: i64) -> Option<Self>

Creates a peer identity for a small group chat.

Source

pub fn channel(id: i64) -> Option<Self>

Creates a peer identity for a broadcast channel, megagroup, gigagroup or monoforum.

Source

pub fn kind(self) -> PeerKind

Peer kind.

Source

pub fn bot_api_dialog_id(&self) -> i64

Returns the identity using the Bot API Dialog ID format.

Will return an arbitrary value if Self::kind is PeerKind::UserSelf. This value should not be relied on and may change between releases.

Source

pub fn bare_id(&self) -> i64

Unpacked peer identifier. Panics if Self::kind is PeerKind::UserSelf.

Trait Implementations§

Source§

impl Clone for PeerId

Source§

fn clone(&self) -> PeerId

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PeerId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for PeerId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> From<&'a Peer> for PeerId

Source§

fn from(peer: &'a Peer) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<&'a PeerChannel> for PeerId

Source§

fn from(channel: &'a PeerChannel) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<&'a PeerChat> for PeerId

Source§

fn from(chat: &'a PeerChat) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<&'a PeerId> for Peer

Source§

fn from(peer: &'a PeerId) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<&'a PeerUser> for PeerId

Source§

fn from(user: &'a PeerUser) -> Self

Converts to this type from the input type.
Source§

impl From<Peer> for PeerId

Source§

fn from(peer: Peer) -> Self

Converts to this type from the input type.
Source§

impl From<PeerChannel> for PeerId

Source§

fn from(channel: PeerChannel) -> Self

Converts to this type from the input type.
Source§

impl From<PeerChat> for PeerId

Source§

fn from(user: PeerChat) -> Self

Converts to this type from the input type.
Source§

impl From<PeerId> for Peer

Source§

fn from(peer: PeerId) -> Self

Converts to this type from the input type.
Source§

impl From<PeerUser> for PeerId

Source§

fn from(user: PeerUser) -> Self

Converts to this type from the input type.
Source§

impl Hash for PeerId

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PeerId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for PeerId

Source§

impl Eq for PeerId

Source§

impl StructuralPartialEq for PeerId

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more