Struct tox_packet::onion::OnionAnnounceResponsePayload

pub struct OnionAnnounceResponsePayload {
    pub announce_status: AnnounceStatus,
    pub ping_id_or_pk: Digest,
    pub nodes: Vec<PackedNode>,
}

Unencrypted payload of OnionAnnounceResponse packet.

announce_status variable contains the result of sent request. It might have values:

• 0: failed to announce ourselves or find requested node
• 1: requested node is found by its long term PublicKey
• 2: we successfully announced ourselves

In case of announce_status is equal to 1 ping_id will contain PublicKey that should be used to send data packets to the requested node. In other cases it will contain ping id that should be used for announcing ourselves.

Serialized form:

Length	Content
1	announce_status (aka is_stored)
32	Onion ping id or PublicKey
[0, 204]	Nodes in packed format

Fields

announce_status: AnnounceStatus

Variable that represents result of sent OnionAnnounceRequest. Also known as is_stored variable

ping_id_or_pk: Digest

Onion ping id or PublicKey that should be used to send data packets

nodes: Vec<PackedNode>

Up to 4 closest to the requested PublicKey DHT nodes

Trait Implementations

impl Clone for OnionAnnounceResponsePayload

pub fn clone(&self) -> OnionAnnounceResponsePayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OnionAnnounceResponsePayload

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

Formats the value using the given formatter.

impl Eq for OnionAnnounceResponsePayload

impl FromBytes for OnionAnnounceResponsePayload

pub fn from_bytes(
    i: &[u8]
) -> IResult<&[u8], OnionAnnounceResponsePayload, (&[u8], ErrorKind)>

Deserialize struct using nom from raw bytes

impl PartialEq<OnionAnnounceResponsePayload> for OnionAnnounceResponsePayload

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

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

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

This method tests for !=.

impl StructuralEq for OnionAnnounceResponsePayload

impl StructuralPartialEq for OnionAnnounceResponsePayload

impl ToBytes for OnionAnnounceResponsePayload

pub fn to_bytes<'a>(
    &self,
    buf: (&'a mut [u8], usize)
) -> Result<(&'a mut [u8], usize), GenError>

Serialize struct into raw bytes using cookie_factory