Struct ApplicationData

pub struct ApplicationData {
    pub application_tag: Tag,
    pub plain_text: Box<[u8]>,
    pub flags: FlagSet<ApplicationFlag>,
    /* private fields */
}

Represents the received decrypted packet carrying the application-layer data.

This structure always owns the data.

Fields

application_tag: Tag

Tag identifying the application-layer protocol.

plain_text: Box<[u8]>

The actual application-layer data.

flags: FlagSet<ApplicationFlag>

Additional flags passed to/from the HOPR protocol layer and the Application layer, serving as a means of local signaling.

For outgoing data, these flags can be used to signal certain modes of operation by the Application layer to the HOPR protocol. For incoming data, the flags can be set by the HOPR protocol to signal various states to the Applications layer.

The flags are never serialized nor deserialized. Whether these flags are eventually materialized over the wire is decided solely by the HOPR protocol layer underneath. The HOPR protocol calls such flags “packet signals”.

Implementations

impl ApplicationData

pub const PAYLOAD_SIZE: usize = 1_012usize

pub fn new<T>(application_tag: T, plain_text: &[u8]) -> ApplicationData

where T: Into<Tag>,

pub fn new_from_owned<T>(tag: T, plain_text: Box<[u8]>) -> ApplicationData

where T: Into<Tag>,

pub fn with_flags<F>(self, flags: F) -> ApplicationData

where F: Into<FlagSet<ApplicationFlag>>,

Creates a new instance with the given flags set.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn estimate_surbs_with_msg<T>(payload: &T) -> usize

where T: AsRef<[u8]>,

Returns the estimated number of SURBs the HOPR packet carrying an ApplicationData instance with payload could hold (or could have held).

impl ApplicationData

pub fn from_bytes(data: &[u8]) -> Result<ApplicationData, PacketError>

pub fn to_bytes(&self) -> Box<[u8]>

Trait Implementations

impl Clone for ApplicationData

fn clone(&self) -> ApplicationData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApplicationData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApplicationData

fn deserialize<__D>( __deserializer: __D, ) -> Result<ApplicationData, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ApplicationData

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

Formats the value using the given formatter.

impl From<Message> for ApplicationData

fn from(message: Message) -> ApplicationData

Converts to this type from the input type.

impl PartialEq for ApplicationData

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

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

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

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

impl Serialize for ApplicationData

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<I, T, C> TryFrom<StartProtocol<I, T, C>> for ApplicationData

where I: Serialize + for<'de> Deserialize<'de>, T: Serialize + for<'de> Deserialize<'de>, C: Into<u8> + TryFrom<u8>,

type Error = StartProtocolError

The type returned in the event of a conversion error.

fn try_from( value: StartProtocol<I, T, C>, ) -> Result<ApplicationData, <ApplicationData as TryFrom<StartProtocol<I, T, C>>>::Error>

Performs the conversion.

impl Eq for ApplicationData

impl StructuralPartialEq for ApplicationData