Struct tox_packet::relay::OobSend

pub struct OobSend {
    pub destination_pk: PublicKey,
    pub data: Vec<u8>,
}

Sent by client to server. If a peer with private key equal to the key they announced themselves with is connected, the data in the OOB send packet will be sent to that peer as an OOB recv packet. If no such peer is connected, the packet is discarded. The toxcore TCP_server implementation has a hard maximum OOB data length of 1024. 1024 was picked because it is big enough for the net_crypto packets related to the handshake and is large enough that any changes to the protocol would not require breaking TCP server. It is however not large enough for the bigges net_crypto packets sent with an established net_crypto connection to prevent sending those via OOB packets.

OOB packets can be used just like normal data packets however the extra size makes sending data only through them less efficient than data packets.

Serialized form:

Length	Content
1	0x06
32	Public Key
variable	Data

Fields

destination_pk: PublicKey

Public Key of the receiver

data: Vec<u8>

OOB data packet

Trait Implementations

impl Clone for OobSend

pub fn clone(&self) -> OobSend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OobSend

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

Formats the value using the given formatter.

impl FromBytes for OobSend

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

Deserialize struct using nom from raw bytes

impl PartialEq<OobSend> for OobSend

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

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

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

This method tests for !=.

impl StructuralPartialEq for OobSend

impl ToBytes for OobSend

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