TextSource

Enum TextSource 

Source
pub enum TextSource {
    Direct {
        peer: PublicKey,
    },
    ChannelGroup {
        channel: ChannelTag,
        hint: NodeHint,
        full_key: Option<PublicKey>,
    },
    ChannelDirect {
        channel: ChannelTag,
        peer: PublicKey,
    },
}
Expand description

Who a received text payload came from, and over what.

Variants§

§

Direct

Authenticated unicast from a peer.

Fields

§peer: PublicKey
§

ChannelGroup

Multicast to a channel. The sender claims a hint; the full key is present only when they addressed the frame with it.

Fields

§channel: ChannelTag
§hint: NodeHint
§full_key: Option<PublicKey>
§

ChannelDirect

Blind unicast to us over a channel key, from an addressable peer.

Fields

§channel: ChannelTag
§peer: PublicKey

Implementations§

Source§

impl TextSource

Source

pub fn channel(&self) -> Option<ChannelTag>

Source

pub fn envelope(&self) -> Envelope

The engine envelope for a payload from this source.

A multicast member is always the claimed hint, with any full key passed beside it: naming the key here instead would split one member into two streams the moment a frame omitted it.

Source

pub fn full_key(&self) -> Option<PublicKey>

The sender’s full key, when the frame carried or authenticated one.

Trait Implementations§

Source§

impl Clone for TextSource

Source§

fn clone(&self) -> TextSource

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextSource

Source§

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

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

impl PartialEq for TextSource

Source§

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

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

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 TextSource

Source§

impl Eq for TextSource

Source§

impl StructuralPartialEq for TextSource

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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> Same for T

Source§

type Output = T

Should always be Self
§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.