Enum Vortex

pub enum Vortex {
    DownloadPiece(Header, DownloadPiece),
    PieceContent(Header, PieceContent),
    Reserved(Header),
    Close(Header),
    Error(Header, Error),
}

Vortex Protocol

Vortex is a peer-to-peer (P2P) file transfer protocol using TLV (Tag-Length-Value) format for efficient and flexible data transmission. Designed for reliable and scalable file sharing.

Packet Format: - Packet Identifier (8 bits): Uniquely identifies each packet - Tag (8 bits): Specifies data type in value field - Length (32 bits): Indicates Value field length, up to 4 GiB - Value (variable): Actual data content, maximum 1 GiB

Protocol Format:

-------------------------------------------------------------------------------------------------
|                            |                   |                    |                         |
| Packet Identifier (8 bits) |    Tag (8 bits)   |  Length (32 bits)  |   Value (up to 4 GiB)   |
|                            |                   |                    |                         |
-------------------------------------------------------------------------------------------------

For more information, please refer to the Vortex Protocol.

Variants

DownloadPiece(Header, DownloadPiece)

PieceContent(Header, PieceContent)

Reserved(Header)

Close(Header)

Error(Header, Error)

Implementations

impl Vortex

Vortex implements the Vortex functions.

pub fn new(tag: Tag, value: Bytes) -> Result<Self>

Creates a new Vortex packet.

pub fn packet_id(&self) -> u8

packet_id returns the packet identifier of the Vortex packet.

pub fn tag(&self) -> &Tag

tag returns the tag of the Vortex packet.

pub fn length(&self) -> usize

length returns the length of the value field.

pub fn from_bytes(bytes: Bytes) -> Result<Self>

from_bytes creates a Vortex packet from a byte slice.

pub fn to_bytes(&self) -> Bytes

to_bytes converts the Vortex packet to a byte slice.

Trait Implementations

impl Debug for Vortex

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

Formats the value using the given formatter.

impl TryFrom<(Tag, Header, Bytes)> for Vortex

Implement TryFrom<(tlv::Tag, Header, Bytes)> for Vortex.

fn try_from((tag, header, value): (Tag, Header, Bytes)) -> Result<Self>

try_from converts a tuple of Tag, Header, and Bytes into a Vortex packet.

type Error = Error

The type returned in the event of a conversion error.