Enum SessionCapability 

#[repr(u8)]
pub enum SessionCapability {
    Segmentation = 0,
    RetransmissionAck = 1,
    RetransmissionNack = 2,
    NoDelay = 3,
    NoRateControl = 4,
}

Individual capabilities of a Session.

Variants

Segmentation = 0

Frame segmentation.

RetransmissionAck = 1

Frame retransmission (ACK-based)

Implies [Segmentation].

RetransmissionNack = 2

Frame retransmission (NACK-based)

Implies [Segmentation].

NoDelay = 3

UDP-like behavior: disable packet buffering, and — on stateless (non-retransmitting) sessions — preserve datagram boundaries by emitting each write as exactly one frame (delivered to the peer as exactly one read), regardless of frame_mtu. Use this for datagram-oriented targets (e.g. UDP/WireGuard) that must not have datagrams split or coalesced. On reliable (retransmitting) sessions only the buffering behavior applies; boundary preservation is stateless-only (the NACK missing-segment bitmap cannot address the segments of an oversized datagram frame).

Boundary preservation holds only up to the reader’s buffer: a single read cannot return more bytes than its buffer, so a datagram larger than the peer’s read buffer is still delivered in multiple reads. Callers must therefore size the read buffer for the largest datagram they need preserved. In the UDP-forwarding path the datagram size is bounded at ingress by the forwarding buffer (HOPR_UDP_BUFFER_SIZE), so it never exceeds it there; a datagram-mode frame may otherwise be as large as 64 * SESSION_MTU.

Implies [Segmentation].

NoRateControl = 4

Disable SURB-based egress rate control.

This applies only to the recipient of the Session (Exit).

Trait Implementations

impl<R> BitAnd<R> for Capability

where R: Into<FlagSet<Capability>>,

type Output = FlagSet<Capability>

The resulting type after applying the & operator.

fn bitand(self, rhs: R) -> <Capability as BitAnd<R>>::Output

Performs the & operation.

impl<R> BitOr<R> for Capability

where R: Into<FlagSet<Capability>>,

type Output = FlagSet<Capability>

The resulting type after applying the | operator.

fn bitor(self, rhs: R) -> <Capability as BitOr<R>>::Output

Performs the | operation.

impl<R> BitXor<R> for Capability

where R: Into<FlagSet<Capability>>,

type Output = FlagSet<Capability>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: R) -> <Capability as BitXor<R>>::Output

Performs the ^ operation.

impl Clone for Capability

fn clone(&self) -> Capability

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Capability

impl Debug for Capability

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Capability

fn deserialize<D>( deserializer: D, ) -> Result<Capability, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Capability

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

Formats the value using the given formatter.

impl Eq for Capability

impl From<Capability> for FlagSet<Capability>

fn from(value: Capability) -> FlagSet<Capability>

Converts to this type from the input type.

impl FromStr for Capability

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Capability, <Capability as FromStr>::Err>

Parses a string s to return a value of this type.

impl Not for Capability

type Output = FlagSet<Capability>

The resulting type after applying the ! operator.

fn not(self) -> <Capability as Not>::Output

Performs the unary ! operation.

impl Ord for Capability

fn cmp(&self, other: &Capability) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Capability

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Capability

fn partial_cmp(&self, other: &Capability) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R> Rem<R> for Capability

where R: Into<FlagSet<Capability>>,

type Output = FlagSet<Capability>

The resulting type after applying the % operator.

fn rem(self, rhs: R) -> <Capability as Rem<R>>::Output

Performs the % operation.

impl Serialize for Capability

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 StructuralPartialEq for Capability

impl<R> Sub<R> for Capability

where R: Into<FlagSet<Capability>>,

type Output = FlagSet<Capability>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> <Capability as Sub<R>>::Output

Performs the - operation.

impl TryFrom<&str> for Capability

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Capability, <Capability as TryFrom<&str>>::Error>

Performs the conversion.