Enum PacketType

#[repr(u8)]
pub enum PacketType {
    Sync = 83,
    Echo = 69,
    EchoReply = 101,
    Connect = 67,
    Finish = 70,
    Reset = 82,
    Accept = 65,
    Data = 68,
    Pause = 88,
}

The serializable enumeration of packet types that can be used over a usb vsock link. These roughly correspond to the state machine described by the fuchsia.hardware.vsock fidl library.

Variants

Sync = 83

Synchronizes the connection between host and device. Each side must send and receive a sync packet with the same payload before any other packet may be recognized on the usb connection. If this packet is received mid-stream, all connections must be considered reset to avoid data loss. It should also only ever be the last vsock packet in a given usb packet.

Echo = 69

An outbound echo request. The other end should reply to this with the same body and all the same fields in a PacketType::EchoReply packet, no matter the state of the connection.

EchoReply = 101

A reply to a PacketType::Echo request packet. The body and all header fields should be set the same as the original echo packet’s.

Connect = 67

Connect to a cid:port pair from a cid:port pair on the other side. The payload must be empty.

Finish = 70

Notify the other end that this connection should be closed. The other end should respond with an PacketType::Reset when the connection has been closed on the other end. The payload must be empty.

Reset = 82

Terminate or refuse a connection on a particular cid:port pair set. There must have been a previous PacketType::Connect request for this, and after this that particular set of pairs must be considered disconnected and no more PacketType::Data packets may be sent for it unless a new connection is initiated. The payload must be empty.

Accept = 65

Accepts a connection previously requested with PacketType::Connect on the given cid:port pair set. The payload must be empty.

Data = 68

A data packet for a particular cid:port pair set previously established with a PacketType::Connect and PacketType::Accept message. If all of the cid and port fields of the packet are zero, this is for a special data stream between the host and device that does not require an established connection.

Pause = 88

Advisory flow control message. Payload indicates flow control state “on” or “off”. If “on”, it is recommended that the receiver not send more data for this connection if possible, until the state becomes “off” again. State is assumed “off” when no packet has been received.

Trait Implementations

impl Clone for PacketType

fn clone(&self) -> PacketType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PacketType

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

Formats the value using the given formatter.

impl Hash for PacketType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoBytes for PacketType

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl KnownLayout for PacketType

where Self: Sized,

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

impl Ord for PacketType

fn cmp(&self, other: &PacketType) -> 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 PacketType

fn eq(&self, other: &PacketType) -> 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 PartialOrd for PacketType

fn partial_cmp(&self, other: &PacketType) -> 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 TryFromBytes for PacketType

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl Copy for PacketType

impl Eq for PacketType

impl Immutable for PacketType

impl StructuralPartialEq for PacketType

impl Unaligned for PacketType