Struct tox_packet::onion::InnerOnionAnnounceRequest

pub struct InnerOnionAnnounceRequest {
    pub nonce: Nonce,
    pub pk: PublicKey,
    pub payload: Vec<u8>,
}

It's used for announcing ourselves to onion node and for looking for other announced nodes.

If we want to announce ourselves we should send one OnionAnnounceRequest packet with PingId set to 0 to acquire correct PingId of onion node. Then using this PingId we can send another OnionAnnounceRequest to be added to onion nodes list. If OnionAnnounceRequest succeed we will get OnionAnnounceResponse with announce_status set to 2. Otherwise announce_status will be set to 0.

If we are looking for another node we should send OnionAnnounceRequest packet with PingId set to 0 and with PublicKey of this node. If node is found we will get OnionAnnounceResponse with announce_status set to 1. Otherwise announce_status will be set to 0.

Serialized form:

Length	Content
1	0x83
24	Nonce
32	Temporary or real PublicKey
variable	Payload

where payload is encrypted OnionAnnounceRequestPayload

Fields

nonce: Nonce

Nonce for the current encrypted payload

pk: PublicKey

Temporary or real PublicKey for the current encrypted payload

payload: Vec<u8>

Encrypted payload

Implementations

impl InnerOnionAnnounceRequest

pub fn new(
    shared_secret: &PrecomputedKey,
    pk: &PublicKey,
    payload: &OnionAnnounceRequestPayload
) -> InnerOnionAnnounceRequest

Create new InnerOnionAnnounceRequest object.

pub fn get_payload(
    &self,
    shared_secret: &PrecomputedKey
) -> Result<OnionAnnounceRequestPayload, GetPayloadError>

Decrypt payload and try to parse it as OnionAnnounceRequestPayload.

Returns Error in case of failure:

• fails to decrypt
• fails to parse as OnionAnnounceRequestPayload

Trait Implementations

impl Clone for InnerOnionAnnounceRequest

pub fn clone(&self) -> InnerOnionAnnounceRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InnerOnionAnnounceRequest

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

Formats the value using the given formatter.

impl Eq for InnerOnionAnnounceRequest

impl FromBytes for InnerOnionAnnounceRequest

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

Deserialize struct using nom from raw bytes

impl PartialEq<InnerOnionAnnounceRequest> for InnerOnionAnnounceRequest

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

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

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

This method tests for !=.

impl StructuralEq for InnerOnionAnnounceRequest

impl StructuralPartialEq for InnerOnionAnnounceRequest

impl ToBytes for InnerOnionAnnounceRequest

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